Spring Boot 集成 Swagger2

使用 Swagger 可以代替写接口文档，并且它提供对接口的调试

1.引入 springfox-swagger2，springfox-swagger-ui 包。
2.添加 Swagger 配置类。

• 通过 @EnableSwagger2 启动swagger。
• 通过 Docket（一个Docket就是一个模块）可以设置模块名称(groupName)、要扫描的包、要展现的接口。
• 通过 Docket 的 ApiInfo 设置模块描述信息。

3.在接口上添加 Swagger 注解。

Swagger2常用注解：
@Api：用在类上，说明该类的作用
@ApiIgnore：使用该注解忽略这个API
@ApiOperation：用在方法上，说明方法的作用
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
    paramType：参数通过什么方式传到后台
        header -->请求参数的获取：@RequestHeader
        query -->请求参数的获取：@RequestParam
        path（用于restful接口）-->请求参数的获取：@PathVariable                 
        body（用于restful接口，传输VO）
        form（不常用）
    name：参数名
    value：参数的描述
    dataType：参数类型
    required：参数是否必须传
    defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
    code：数字，例如400
    message：信息，例如"请求参数没填好"
    response：抛出异常的类
@ApiModel：描述一个Model的信息（这种一般用在post创建的时候。使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：描述一个model的属性

使用 spring-boot-starter-swagger 更为方便，减少了些重复信的配置。其中有4个配置类对swagger进行了封装，在使用的时候可以看下其源码。

我的Demo地址

swagger相关参考地址：
Spring Boot中使用Swagger2构建强大的RESTful API文档 By 翟永超
SpringBoot开发案例之整合Swagger篇 By 小柒
spring-boot-starter-swagger

转载于:https://my.oschina.net/ZhongCW/blog/1787624