swagger常见问题

最新推荐文章于 2024-09-15 15:14:28 发布

原创最新推荐文章于 2024-09-15 15:14:28 发布 · 438 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

异常专栏收录该内容

5 篇文章

订阅专栏

该博客讨论了Swagger响应描述不可见的两个常见问题：返回类型未指定泛型和返回参数使用全大写字母。为了解决这个问题，建议在响应类上添加@JsonAutoDetect注解，设置字段可见性，并配合使用@ApiModelProperty和@XmlField注解来规范字段的显示。通过这些方法，可以确保Swagger正确地展示响应描述。

如果 swagger 响应描述看不见问题可有如下两个：
1、返回类型需要明确泛型：
在这里插入图片描述

2、返回参数全大写：
解决办法：在类上添加如下代码
@JsonAutoDetect(
fieldVisibility = JsonAutoDetect.Visibility.ANY,
getterVisibility = JsonAutoDetect.Visibility.NONE,
setterVisibility = JsonAutoDetect.Visibility.NONE
)

@Data
@JsonAutoDetect(
        fieldVisibility = JsonAutoDetect.Visibility.ANY,
        getterVisibility = JsonAutoDetect.Visibility.NONE,
        setterVisibility = JsonAutoDetect.Visibility.NONE
)
public class MzPayResponse {

    @ApiModelProperty(value = "门诊号")
    @XmlField("C1")
    private String CMZH;

    @ApiModelProperty(value = "收费单")
    @XmlField("C2")
    private String CSFD;
}