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>

1.swagger配置:

Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

通过Appinfo配置

 

 其中contact是作者信息

2.swagger生产环境中关闭、过滤及扫描指定包

关闭 通过Docker.enable关闭

过滤通过.path(路径)过滤

自定义扫描

 

 3.分组

通过.gruopName()分组

示例

 

 效果

 

 4.swagger-ui操作即注解

swagger操作

测试controller

 

 点击try it out

 

 code表示状态

常用注解

Swagger注解	简单说明
@Api(tags = "xxx模块说明")	作用在模块类上
@ApiOperation("xxx接口说明")	作用在接口方法上
@ApiModel("xxxPOJO说明")	作用在模型类上：如VO、BO
@ApiModelProperty(value = "xxx属性说明",hidden = true)	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam("xxx参数说明")	作用在参数、方法和字段上，类似@ApiModelProperty

@ApiModel 和 @ApiModelPropertery

添加在实体类的和实体类属性添加说明

ps:swagger是前后端分离技术