SpringBoot整合Swagger3.0.0

一、POM添加依赖

<dependency>

   <groupId>io.springfox</groupId>

   <artifactId>springfox-boot-starter</artifactId>

   <version>3.0.0</version>

</dependency>

 

二、Application启动应用类上面加入@EnableOpenApi注解

@EnableOpenApi

@SpringBootApplication

public class Swagger3Application {

  public static void main(String[] args) {

    SpringApplication.run(Swagger3Application.class, args);

  }

}

三、Swagger3Config的配置

 

@Configuration

public class Swagger3Config {

  @Bean

  public Docket createRestApi() {

    return new Docket(DocumentationType.OAS_30)

        .apiInfo(apiInfo())

        .select()

        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))

        .paths(PathSelectors.any())

        .build();

  }

 

  private ApiInfo apiInfo() {

    return new ApiInfoBuilder()

        .title("Swagger3接口文档")

        .description("更多请咨询服务开发者XXX")xxx

        .contact(new Contact("作者", "作者地址", "作者邮箱"))

        .version("1.0")

        .build();

  }

}

四、Swagger注解的使用说明

@Api：用在请求的类上，表示对类的说明

  tags="说明该类的作用，可以在UI界面上看到的注解"

  value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用

  value="说明方法的用途、作用"

  notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明

  @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

    name：参数名

    value：参数的汉字说明、解释

    required：参数是否必须传

    paramType：参数放在哪个地方

      · header --> 请求参数的获取：@RequestHeader

      · query --> 请求参数的获取：@RequestParam

      · path（用于restful接口）--> 请求参数的获取：@PathVariable

      · body（不常用）

      · form（不常用） 

    dataType：参数类型，默认String，其它值dataType="Integer"   

    defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应

  @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

    code：数字，例如400

    message：信息，例如"请求参数没填好"

    response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息

      （这种一般用在post创建的时候，使用@RequestBody这样的场景，

      请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：用在属性上，描述响应类的属性

 

五、Controller层的配置：

@Api(tags = "用户信息管理")

@RestController

@RequestMapping("userRecord")

public class UserRecordController extends ApiController {

  /**

   * 服务对象

   */

  @Resource

  private UserRecordService userRecordService;

 

  /**

   * 分页查询所有数据

   * @param page    分页对象

   * @param userRecord 查询实体

   * @return 所有数据

   */

  @ApiOperation("分页查询所有数据")

  @GetMapping("page")

  public R selectAll(Page<UserRecord> page, UserRecord userRecord) {

    return success(this.userRecordService.page(page, new QueryWrapper<>(userRecord)));

  }

}

 

六、注意事项

1. 这次更新，移除了原来默认的swagger页面路径：http://host/context-path/swagger-ui.html，新增了两个可访问路径：http://host/context-path/swagger-ui/index.html和http://host/context-path/swagger-ui/
2. 通过调整日志级别，还可以看到新版本的swagger文档接口也有新增，除了以前老版本的文档接口/v2/api-docs之外，还多了一个新版本的/v3/api-docs接口。
3. DocumentationType 变化