如何为 json 负载定义 swagger 注释

Question

如何为此示例定义 swagger 注释 post API.TenantConfiguration 正在作为 json 有效载荷获取。

@Consumes({ "application/json", "application/xml" })
@POST
    public Message configureSettings(TenantConfiguration configuration)
            throws AndroidAgentException {
.....................
}

Answer 1

我找到了注释 json 使用 Jax-rs Apis.It 正常工作的解决方案。

@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 对象映射 class。

@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 注释

How to define swagger annotation for json payload

java

rest

jax-rs

swagger