swagger的使用

1. 首先引入依赖

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

    

2.  增加swagger配置类

   @Configuration
   @EnableSwagger2
   public class SwaggerConfig {
   
       @Bean
       public Docket createRestApi() {
           return new Docket(DocumentationType.SWAGGER_2)
                   .apiInfo(apiInfo())
                   .select()// 为当前包路径
                   .apis(RequestHandlerSelectors.basePackage("com.cloud.providerservice.service"))
                   .paths(PathSelectors.any())
   //                .paths(PathSelectors.none()) 禁用
                   .build();
       }
   
       private ApiInfo apiInfo() {
           return new ApiInfoBuilder()
                   .title("Provider API")
                   .description("API 描述").build();
       }
   }

   例如生产环境需要禁用swagger只需将

   PathSelectors.any()改为

   PathSelectors.none()

3. 在接口类增加swagger注解

4. 启动程序浏览器打开http://localhost:2222/swagger-ui.html ，就能看到api文档