SpringBoot集成Swagger生成文档

末蓝、 2022-04-22 13:04 351阅读 0赞

swagger是啥？这个不多比比，也许你们比我还了解，接口文档如何生成？ 为了不浪费各位看官的时间，直接上流程！  
一、添加依赖

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

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70]

二、创建Swagger2配置类  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 1]

import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    
    /**
     * Swagger2配置类
     * 在与spring boot集成时，放在与Application.java同级的目录下。
     * 通过@Configuration注解，让Spring来加载该类配置。
     * 再通过@EnableSwagger2注解来启用Swagger2。
     */
    @Configuration
    public class Swagger {
    
        /**
         * 创建API应用
         * apiInfo() 增加API相关信息
         * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
         * 本例采用指定扫描的包路径来定义指定要建立API的目录。
         *
         * @return
         */
        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.ziding.product.cooperation")) //看我上图路径你就知道怎么写
                    .paths(PathSelectors.any())
                    .build();
        }
    
    
        /**
         * 创建api的基本信息
         * 访问地址： http://localhost:9989/swagger-ui.html
         *
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("swagger-api文档")
                    .description("文档描述qaq")
                    .termsOfServiceUrl("")
                    .contact("ziding")
                    .version("1.0")
                    .build();
        }
    }

三、在启动类上添加注解@EnableSwagger2  
![在这里插入图片描述][20181105125748132.png]  
四、Swagger注解的各种使用这里就不一一介绍了，有时间另开一贴  
。。。

五、这就可以了？ 那运行试试？

哎？ 这是什么情况？  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 2]  
后台警告信息：  
![在这里插入图片描述][20181105124647968.png]

上述问题是由于资源映射导致  
解决办法：  
让swagger配置类继承WebMvcConfigurerAdapter类  
![在这里插入图片描述][201811051253187.png]  
添加如下代码

@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/");
        }

OK，大功告成  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 3]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70]: /images/20220422/04effa389a664c3da5086707e73f5d74.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 1]: /images/20220422/8b6e556bf02e42cbb882409746433a62.png
[20181105125748132.png]: /images/20220422/903c9757c04649ce85d43bf8a187a0d5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 2]: /images/20220422/b67ced2d0ec04aa3b1226252a3021a0a.png
[20181105124647968.png]: /images/20220422/941377f83d6746058b708a5aecbdae2f.png
[201811051253187.png]: /images/20220422/6b98fb1ca34c42169e4a4160c11779a1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQyNTk1MDc3_size_16_color_FFFFFF_t_70 3]: /images/20220422/dab4653df538457cb533dc17b8650c0c.png