Swagger Annotation 添加一个 json 示例到响应 class
Swagger Annotation to add a json example to the response class
如何使用 swagger 注释插入默认值而不是“{}”?
您需要使用 @ApiResponses 和 @ApiResponse[= 注释您的 Rest 方法26=].
例如
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful retrieval of demand",responseContainer="List"),
@ApiResponse(code = 404, message = "Demand does not exist", response = Your Error response.class),
@ApiResponse(code = 500, message = "Internal server error", response = Your Error response.class)
}
)
用 @ApiModel 注释你的 Json 响应 class 并用 注释它的字段@ApiModelProperty 喜欢
@ApiModel(description = "Your comment")
public class Demand implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(notes = "Your comments", required = true, example = "example value")
private String demandId;
}
如何使用 swagger 注释插入默认值而不是“{}”?
您需要使用 @ApiResponses 和 @ApiResponse[= 注释您的 Rest 方法26=].
例如
@ApiResponses(value = {
@ApiResponse(code = 200, message = "Successful retrieval of demand",responseContainer="List"),
@ApiResponse(code = 404, message = "Demand does not exist", response = Your Error response.class),
@ApiResponse(code = 500, message = "Internal server error", response = Your Error response.class)
}
)
用 @ApiModel 注释你的 Json 响应 class 并用 注释它的字段@ApiModelProperty 喜欢
@ApiModel(description = "Your comment")
public class Demand implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(notes = "Your comments", required = true, example = "example value")
private String demandId;
}