swagger实体类生成不了文档的解决办法

最新推荐文章于 2025-05-16 10:51:20 发布

原创最新推荐文章于 2025-05-16 10:51:20 发布 · 1.3k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#swagger2

java 专栏收录该内容

7 篇文章

订阅专栏

当使用Swagger2时，遇到嵌套实体类如RetPagedRowsVo在List rows字段上添加ApiModelProperty注解会导致文档无法生成。解决方法是移除该注解。

嵌套实体类 RetPagedRowsVo，在嵌套的List rows的上边不要有ApiModelProperty注解，不然生成不了文档

swagger版本

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.8.0</version>
</dependency>
<dependency>
  <groupId>com.github.xiaoymin</groupId>
  <artifactId>swagger-bootstrap-ui</artifactId>
  <version>1.9.3</version>
</dependency>

嵌套实体类 RetPagedRowsVo，在嵌套的List rows的上边不要有ApiModelProperty注解，不然生成不了文档

public class RetPagedRowsVo<T> {

    /// 页码
    @ApiModelProperty(value = "页码", name = "pageIndex", example = "1")
    private Long pageIndex;
    /// 每页数
    @ApiModelProperty(value = "每页数", name = "pageSize", example = "20")
    private Long pageSize;
    ///总数量
    @ApiModelProperty(value = "总数量", name = "count", example = "500")
    private Long count;
    // ！！！数据行，这里不要有ApiModelProperty注解，不然生产不了文档
    private List<T> rows;
}