Swagger

Swagger-UI介绍

lSwagger-UI可以让任何人在不实现任何逻辑的情况下，以可视化的方式与后台服务端API接口方法进行交互。

lSwagger-UI的配置不会污染其他业务代码，通过引入Swagger-UI的配置即可自动生成相应的可视化接口文档，来对项目中的接口进行测试；

极大的简化了客户端与服务端的访问，方便开发和测试人员使用。

导入依赖：

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

上面的是可视化界面，下面的是读取controller的依赖。

配置类：

 @Configuration
 @EnableSwagger2
 public class SwaggerConfiguration {
     //定义API接口映射路径   
     public static final String DEFAULT_INCLUDE_PATTERN = "/user/.*";
     @Bean
     public Docket swaggerSpringfoxDocket() {
              //用于生成对应API接口文档的描述信息，可省略
              ApiInfo apiInfo = new ApiInfo("用户管理API接口测试文档","description",
                 "termsOfServiceUrl","contact","version","","");
             Docket docket = new Docket(DocumentationType.SWAGGER_2)
                          .apiInfo(apiInfo)
                        ...  
                          .paths(regex(DEFAULT_INCLUDE_PATTERN))//匹配路径生成对应接口文档 
                          .build();
                          return docket;
     }
 }
 ​

启动项目

进入文档：

服务地址IP+端口+/swagger-ui.html