SpringBoot 教程 & 笔记 |Demo06- 整合 Swagger2 API 文档

本文主要讲解如何在springboot下整合Swagger2 API文档。

本教程在Demo05基础上添加Swagger2 API文档配置信息

添加依赖

在 SpringBoot 教程&笔记 |Demo04-整合 MyBatis-Plus 已经添加过此依赖，略过这部！

引入 springfox-swagger 依赖：

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

配置 Swagger2 类

Swagger2配置类,放在与Application.java同级的目录下。
Swagger2配置类,放在与Application.java同级的目录下。
Swagger2配置类,放在与Application.java同级的目录下。

在 controller 层,添加注解，使用 Swagger2

注解解释：
@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：用在属性上，描述响应类的属性

启动项目
启动项目，然后访问 http://localhost:8080/swagger-ui.html 来查看。


扩展配置
后台返回Long格式时，由于JavaScript中Number类型的自身原因，并不能完全表示Long型的数字，在Long长度大于17位时会出现精度丢失的问题。

通过重载 WebMvcConfigurationSupport 的 configureMessageConverters 方法，是返回的 Long 格式变成 String 格式，原 Controller 不用修改

重载 configureMessageConverters 方法后，发现启动项目无法访问 http://localhost:8080/swagger-ui.html，后台提示 No mapping for GET /swagger-ui.html,通过重载 addResourceHandlers 方法的来实现

添加 src/main/java/com/heardfate/springboot/demo/demo04/config/MyWebMvcConfiguration.java 重载 WebMvcConfigurationSupport 方法