swagger实用接口文档生成框架

最新推荐文章于 2024-09-08 10:10:11 发布

Kelanss

最新推荐文章于 2024-09-08 10:10:11 发布

阅读量738

点赞数

分类专栏：工具使用 SpringMVC 文章标签： swagger

本文链接：https://blog.csdn.net/kelanQ/article/details/53335963

版权

SpringMVC 同时被 2 个专栏收录

11 篇文章 0 订阅

订阅专栏

工具使用

7 篇文章 0 订阅

订阅专栏

本文介绍如何利用springfox代替swagger-springmvc，避免将swagger-ui的视图文件复制到项目静态资源目录。springfox简化了在springmvc中集成swagger的步骤，参考了StackOverflow和GitHub的相关资源。

摘要由CSDN通过智能技术生成

现在我们用springfox来代替swagger-springmvc的方式实现，在springmvc-swagger模式的话需要把swagger-ui下的视图文件copy到我们项目的静态资源的目录下，
而用springfox就不用把swagger-ui下的视图文件copy到我们项目的静态资源的目录下面了。

springfox的使用如下：
引用依赖：
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.5.0</version>
</dependency> 

创建一个swagger的配置文件：
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.regex("/api/.*"))
            .build()
            .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("TITLE")
            .description("DESCRIPTION")
            .version("VERSION")
            .termsOfServiceUrl("http://terms-of-services.url")
            .license("LICENSE")
            .licenseUrl("http://url-to-license.com")
            .build();
    }

}

我们要用现成的可视化的swagger-ui视图，我们需要引用依赖：
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.5.0</version>
</dependency>

在项目中创建：
@Configuration
@EnableWebMvc
public class WebAppConfig extends WebMvcConfigurerAdapter {

    @Override 
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

在springfox的jar包里面在路径classpath:/META-INF/resources/下会有一个html页面swagger-ui.html
这个页面就是我们最后把我们有相应接口标记注释的地方生成html页面的模板框架页面。