Springfox3一个类多个接口使用解决方案

问题描述

swagger在线文档，多个接口的入参类，字段有大量重复，例如分页查询、新增、修改；如果都用同一个类提供除去，则有的接口会有多余的参入属性，这样的接口文档使用起来不太友好；

---

解决方案

1.不同接口定义不同的类，例如：XXXQueryRequest/XXXCreateRequest/XXXUpdateRequest

带来的问题：

如果有属性变动，包括名称、类型、swagger注解文字等，要大量修改，可能会导致遗漏等问题

2.使用Springfox3-plus

<springfox3Plus.version>1.0-SNAPSHOT</springfox3Plus.version>

<dependency>
      <groupId>com.jiyao</groupId>
      <artifactId>jy-springfox3-plus-core</artifactId>
      <version>${springfox3Plus.version}</version>
</dependency>

git地址

功能点：

1.文档中的入参，支持按照java类中属性位置展示

2.支持入参属性分组；同一个类被不同场景使用

依赖好用的开源包

  <dependencies>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
    </dependency>

    <dependency>
      <groupId>cn.hutool</groupId>
      <artifactId>hutool-all</artifactId>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-ui</artifactId>
    </dependency>

    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>

  </dependencies>

推荐

有个好工具墙裂推荐

3.10 导出离线文档 | Knife4j