Swagger：从参数示例值中删除类属性

Question

我正在使用Swagger来记录REST API。

我正在上这样的课：

public class Source{ 
    private String url;
    private String category;
    private String label;
    ... 
}

我目前正在使用@Api的含义参数设置dataType为Source.class，但我有多个POST请求，将JSON作为主体参数，比方说，其中的一个变量，例如：

{"label": "labelA"}

由于前面设置了dataType，Swagger UI显示的示例值是一个完整的Source。类，类似于：

{
    "url": "string",
    "category": "string",
    "label": "string",
    ...
}

我能以某种方式为这些请求的每个请求切掉Swagger UI显示的示例值吗？我的意思是getSourceFromUrl（）请求应该得到一个仅包含url字段的JSON，并且示例应该显示这一点，而不是完整Source.classJSON。

提前感谢大家！

更新

我正在使用 JAX-RS。如果需要，请向我询问更多意见。

Answer 1

暂时，你不能做这样的事情。您必须为每种情况创建一个不同的类。

参见 swagger-core 的 github：https://github.com/swagger-api/swagger-core/issues/1863#issuecomment-237339565

Answer 2

如果您使用的是spingfox-swagger2，则有一个注释@ApiModel属性可以执行此操作。

例：

@ApiModelProperty(required = false, hidden = true)
private String label;