How to define swagger annotation for json payload(如何为 json 有效负载定义 swagger 注释)
问题描述
如何为这个示例 post API 定义 swagger 注释.TenantConfiguration 正在获取为 json 有效负载.
how to define swagger annotation for this example post API.TenantConfiguration is getting as a json payload.
@Consumes({ "application/json", "application/xml" })
@POST
public Message configureSettings(TenantConfiguration configuration)
throws AndroidAgentException {
.....................
}
推荐答案
我找到了一个使用 Jax-rs APIs 注释 json 的解决方案.它工作正常.
I found a solution to annotate json consuming Jax-rs Apis.It's working properly.
@POST
@ApiOperation(
consumes = MediaType.APPLICATION_JSON,
httpMethod = "POST",
value = "Configuring Android Platform Settings",
notes = "Configure the Android platform settings using this REST API"
)
@ApiResponses(value = {
@ApiResponse(code = 201, message = "Android platform configuration saved successfully"),
@ApiResponse(code = 500, message = "Internal Server Error")
})
Message configureSettings(@ApiParam(name = "configuration", value = "AndroidPlatformConfiguration")
TenantConfiguration configuration) throws AndroidAgentException;
JSON 对象的映射类.
Mapping class for the JSON object.
@XmlRootElement(
name = "tenantConfiguration"
)
@XmlAccessorType(XmlAccessType.NONE)
@ApiModel(
value = "TenantConfiguration",description = "This class carries all
information related to a Tenant configuration"
)
public class TenantConfiguration implements Serializable {
@XmlElement(
name = "type"
)
@ApiModelProperty(
name = "type",
value = "type of device",
required = true
)
private String type;
@ApiModelProperty(
name = "configuration",
value = "List of Configuration Entries",
required = true
)
@XmlElement(
name = "configuration"
)
private List<ConfigurationEntry> configuration;
public TenantConfiguration() {
}
public String getType() {
return this.type;
}
public void setType(String type) {
this.type = type;
}
public List<ConfigurationEntry> getConfiguration() {
return this.configuration;
}
public void setConfiguration(List<ConfigurationEntry> configuration) {
this.configuration = configuration;
}
}
这篇关于如何为 json 有效负载定义 swagger 注释的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
本文标题为:如何为 json 有效负载定义 swagger 注释
基础教程推荐
- 如何使用 Stream 在集合中拆分奇数和偶数以及两者的总和 2022-01-01
- 如何使用 Eclipse 检查调试符号状态? 2022-01-01
- 如何对 HashSet 进行排序? 2022-01-01
- Spring Boot Freemarker从2.2.0升级失败 2022-01-01
- 如何强制对超级方法进行多态调用? 2022-01-01
- 在螺旋中写一个字符串 2022-01-01
- 由于对所需库 rt.jar 的限制,对类的访问限制? 2022-01-01
- Java 中保存最后 N 个元素的大小受限队列 2022-01-01
- 如何在不安装整个 WTP 包的情况下将 Tomcat 8 添加到 Eclipse Kepler 2022-01-01
- 首次使用 Hadoop,MapReduce Job 不运行 Reduce Phase 2022-01-01