目录

一、Swagger简介

二、Swagger集成Springboot

        1、创建Springboot项目，添加依赖

        2、配置Swagger基本信息

        3、配置扫描接口

                1、构建Docket时通过select方法配置扫描接口

                2、配置过滤接口

        4、配置开关Swagger

                1、通过enable()方法配置是否启用swagger

                2. 如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

        5、配置api分组

                1、通过groupName()方法即可配置分组：

                2、如何配置多个分组 

        6、实体类配置

三、自定义Swagger皮肤 

        1、默认

        2、bootstarp-ui

        3、mg-ui

---

一、Swagger简介

        Swagger™的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。 

        1、号称世界上最流行的API框架
        2、Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
        3、直接运行，在线测试API
        4、支持多种语言 （如：Java，PHP等）

二、Swagger集成Springboot

        1、创建Springboot项目，添加依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swaggerui
-->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>

        2、配置Swagger基本信息

package com.rk.swagger.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;@Configuration
@EnableSwagger2//开启Swagger2的自动配置
public class SwaggerConfig {@Bean//配置Swagger的Dockert的Bean实例public Docket getDocket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());}//配置Swagger的信息=apiInfoprivate ApiInfo apiInfo(){//作者信息Contact contact=new Contact("罗林","https://blog.csdn.net/m0_46979453?spm=3001.5343","1624603357@qq.com");return new ApiInfo("rk学习Swagger的笔记","勇往直前","v1.0","https://blog.csdn.net/m0_46979453?spm=3001.5343",contact,"Apache 3.0","https://blog.csdn.net/m0_46979453/article/details/121029363",new ArrayList<>());}}

        启动项目访问http://localhost:8080/swagger-ui.html 

        3、配置扫描接口

                1、构建Docket时通过select方法配置扫描接口

 @Bean//配置Swagger的Dockert的Bean实例public Docket getDocket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()//配置要扫描接口的方式   指定扫描com.rk.swagger.controller下的接口//basePackage:指定扫描的包//any():扫描全部//none():不扫描//withClassAnnotation:扫描类上的注解//winthMethodAnnotation:扫描方法上的注解.apis(RequestHandlerSelectors.basePackage("com.rk.swagger.controller")).build();}

            重启项目访问http://localhost:8080/swagger-ui.html  

                2、配置过滤接口

     @Bean//配置Swagger的Dockert的Bean实例public Docket getDocket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.rk.swagger.controller"))//paths过滤什么路径  过滤不想扫描的地方.paths(PathSelectors.ant("/rk/**")).build();}

                现在就是既要扫描controller报下的接口并且接口访问带/rk/** 

        4、配置开关Swagger

                1、通过enable()方法配置是否启用swagger

      @Bean//配置Swagger的Dockert的Bean实例public Docket getDocket(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())//enable 是否启动swagger.enable(false).select()//配置扫描接口.apis(RequestHandlerSelectors.basePackage("com.rk.swagger.controller"))//paths过滤什么路径.paths(PathSelectors.ant("/rk/**")).build();}

                2. 如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

                在启动类上添加:@EnableSwagger2  注解     目前只有dev,test环境才会显示swagger  

        5、配置api分组

                1、通过groupName()方法即可配置分组：

                   如果没有配置分组，默认是default。

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

                2、如何配置多个分组 

                        只需配置多个docket即可

     @Beanpublic Docket getDocket1() {return new Docket(DocumentationType.SWAGGER_2).groupName("group1");}@Beanpublic Docket getDocket2() {return new Docket(DocumentationType.SWAGGER_2).groupName("group2");}@Beanpublic Docket getDocket3() {return new Docket(DocumentationType.SWAGGER_2).groupName("group3");}

                 多人协同开发

        6、实体类配置

@ApiModel("用户实体")//给生成的文档添加注释
public class User {@ApiModelProperty("用户名")public String username;@ApiModelProperty("密码")public String password;
}

                 只要我们的接口中，返回值中存在实体类，他就会被扫描到Swagger中

    @ApiOperation("User控制接口")//给接口添加注释@GetMapping("/rk/user")public User user(){return new User();}

三、自定义Swagger皮肤 

        1、默认

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

                访问:http://localhost:8080/swagger-ui.html

        2、bootstarp-ui

<dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.1</version>
</dependency>

                访问: http://localhost:8080/doc.html 

        3、mg-ui

<dependency><groupId>com.zyplayer</groupId><artifactId>swagger-mg-ui</artifactId><version>1.0.6</version>
</dependency>

                访问 :http://localhost:8080/document.html