Swagger Annotation 将 json 示例添加到响应类

Question

如何使用 swagger 注释插入默认值而不是“{}”？

Answer 1

您需要使用@ApiResponses和@ApiResponse注释您的 Rest 方法。

例如

@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 Response 类及其使用@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;
}