如何为JSON有效负载定义Swagger注释 [英] How to define swagger annotation for json payload

问题描述

如何为该示例帖子API定义醒目的注释.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注释的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！