关于Swagger3的使用

swagger3的使用首先是pom，然后一个配置文件，一个启动类注解即可实现

<!--swagger3-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

@Configuration
@EnableOpenApi
public class Swagger3Config {
//   这里其实还可以做很多的配置
}

 

• 启动类使用注解

  @EnableWebMvc

访问地址为localhost:5202/swagger-ui/index.html，这个路径可以通过设置一些配置来修改为如swagger-ui/*等直接访问，这个后续考虑

其次还有考虑将启动类的Swagger注解放置在Config配置类中的方法，从而实现解耦

---

swagger2:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket webApiConfig(){

        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                //只显示api路径下的页面
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }


    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("供销系统网站-API文档")
                .description("本文档定义了供销项目的全部接口定义")
                .version("1.0")
                .build();
    }

}

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

•  使用的注解

  @EnableSwagger2