So definieren Sie Swagger-Annotation für Json-Payload

Question

So definieren Sie Swagger-Annotation für dieses Beispiel, das API.TenantConfiguration als Json-Payload erhält.

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

Answer 1

Ich fand eine Lösung zu kommentieren Json verbrauchen Jax-rs Apis.Es funktioniert ordnungsgemäß.

@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; 

Mapping-Klasse für das JSON-Objekt.

@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; 
} 
}