SpringBoot集成Swagger生成文档

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


        
            io.springfox
            springfox-swagger2
            2.6.1
        
        
            io.springfox
            springfox-swagger-ui
            2.6.1
        

SpringBoot集成Swagger生成文档_第1张图片

二、创建Swagger2配置类
SpringBoot集成Swagger生成文档_第2张图片

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
SpringBoot集成Swagger生成文档_第3张图片
四、Swagger注解的各种使用这里就不一一介绍了,有时间另开一贴
。。。

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

哎? 这是什么情况?
SpringBoot集成Swagger生成文档_第4张图片
后台警告信息:
在这里插入图片描述

上述问题是由于资源映射导致
解决办法:
让swagger配置类继承WebMvcConfigurerAdapter类
SpringBoot集成Swagger生成文档_第5张图片
添加如下代码

    @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,大功告成
SpringBoot集成Swagger生成文档_第6张图片

你可能感兴趣的:(开发工具)