springboot 集成 swagger-ui

1. 项目目录结构

1.1静态资源路径

类路径下创建swagger-ui-view 文件目录如：

下载swagger-ui 文件，git仓库地址 https://github.com/swagger-api/swagger-ui.git

解压文件，将swagger-ui-master/dist 目录下的所有文件，放入创建的swagger-ui-view文件夹

1.2 类路径文件结构

springMVC 静态资源路径配置：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //将所有/swagger-ui-view/** 访问都映射到classpath:/swagger-ui-view/ 目录下
        registry.addResourceHandler("/swagger-ui-view/**").addResourceLocations("classpath:/swagger-ui-view/");
    }

}

swagger 配置：

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //包路径
                .apis(RequestHandlerSelectors.basePackage("com"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //标题
                .title("springboot swagger API")
                //联系人
                .contact(new Contact("name", "https://blog.csdn.net/qq_27039491", "email@qq.com"))
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }

2.访问设置

启动项目后，访问 http://127.0.0.1:8080/swagger-ui-view/index.html

修改默认地址：编辑index.html 页面，url 地址改为：/v2/api-docs ，用于加载项目api接口

如下：