Swagger 的介绍以及使用

Swagger 的介绍以及使用

本文代码已经同步到码云 ，欢迎你们 star https://gitee.com/njitzyd/JavaDemoCollection

Swagger 简介

Swagger 是一个主要用来在线生成文档的插件，这里主要用来动态生成api接口供先后端进行交互，若是不生成的话就须要写静态文档来交互，那样不只很慢并且不容易修改，那Swagger就能够解决这个问题。

• 号称世界上最流行的API框架
• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
• 直接运行，在线测试API
• 支持多种语言 （如：Java，PHP等）
• 官网：https://swagger.io/

swagger 的使用（基于SpringBoot）

1.引入依赖

新建一个SpringBoot 项目，只加入 web 的启动器，而后添加下面两个依赖：

<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>

2.建立一个DemoController

@RestController
public class DemoController {

    /**
     *
     * @description: 注意这种写法Swagger 会生成不少个接口（虽然参数里指定了GET，Swagger扫描不到）
     * 因此在实际的开发中尽可能使用 @GetMapping 等这种指定了方法的方式
     * @param: []
     * @return: java.lang.String
     * @date: 2020/8/2 
     */
    @RequestMapping(value = "index",method = RequestMethod.GET)
    public String hello(){
        return "helloWorld";
    }
}

3.建立Swagger 的配置类

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}

4.启动项目

访问地址：http://localhost:8080/swagger-ui.html，能够看到Swagger 的页面：

Swagger 的配置

刚刚启动后，页面的内容都是默认的，在实际使用中须要咱们进行配置。

配置Swagger 扫描的接口

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 经过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.njit.swagger.controller"))
      .build();
}

其中RequestHandlerSelectors 有不少能够配置的方法,具体以下，能够根据本身的项目选择：

any() // 扫描全部，项目中的全部接口都会被扫描到
none() // 不扫描接口
// 经过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 经过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

除此以外，咱们还能够经过.paths配置接口扫描过滤：

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 经过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.njit.swagger.controller"))
       // 配置如何经过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/njit/**"))
      .build();
}

PathSelectors 也是能够多种配置的：

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 经过正则表达式控制
ant(final String antPattern) // 经过ant()控制

配置Swagger 的开关

经过enable()方法配置是否启用swagger，若是是false，swagger将不能在浏览器中访问了

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，若是是false，在浏览器将没法访问
      .select()// 经过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.njit.swagger.controller"))
       // 配置如何经过path过滤,即这里只扫描请求以/njit开头的接口
      .paths(PathSelectors.ant("/njit/**"))
      .build();
}

动态配置当项目处于test、dev环境时显示swagger，不然不显示

首先在application.properties 中配置激活的配合环境，而后再作以下配置：

@Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 经过 enable() 接收此参数判断是否要显示
   boolean flag = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(flag) //配置是否启用Swagger，若是是false，在浏览器将没法访问
      .select()// 经过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.njit.swagger.controller"))
       // 配置如何经过path过滤,即这里只扫描请求以/njit开头的接口
      //.paths(PathSelectors.ant("/njit/**"))
      .build();
}

配置API分组

很简单只要配置groupName()便可，若是想要配置多个分组，name就配多个Docket实例，注意实例的名称不能重复。

@Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

配置多个分组

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

实体配置

1. 新建一个实体类能够在上面使用注解（注意，若是接口中的返回值中有实体类，name实体类就会自动被识别为model，不管你加不加注解，固然加注解后会显示你加的注解，比较详细）

// @ApiModel为类添加注释
// @ApiModelProperty为类属性添加注释
@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

经常使用注解

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

这样就能够在controller类以及方法以及参数中使用相应的注解来完善咱们的Swagger，特别说明的是，在生产环境中必定要关闭Swagger，一方面提升性能，更重要的是安全问题，会把本身的接口暴露出去！！！