栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

SpringBoot整合Swagger2-knife4j

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

SpringBoot整合Swagger2-knife4j

1.创建spring boot项目 1.1 创建项目默认都会
spring boot 版本:2.6.4
swagger 版本:2.0.7
1.2 在pom中添加依赖
        
            com.github.xiaoymin
            knife4j-spring-boot-starter
            2.0.7
        
1.3 参考官网swagger 1.4 创建Swagger配置类
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfiguration {

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(documentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTful APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .contact("xx@qq.com")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.github.xiaoymin.knife4j.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
}

官网并没有指明要指定静态文件地址 直接访问可能会报404错误

1.5 可以在启动类指定文件地址
@SpringBootApplication
public class DemoApplication  implements WebMvcConfigurer {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决swagger无法访问
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/meta-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/meta-INF/resources/webjars/");
    }
}
1.6 配置文件中设置服务端口 启动服务
server:
	port: 8081
1.7访问 http://localhost:8081/doc.html 1.8 如果启动报
// 如果启动报这个错误
Failed to start bean ‘documentationPluginsBootstrapper‘

那么在配置文件中添加

spring:
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER
1.9再次启动 大功告成

启动报错原因可访问:处理documentationPluginsBootstrapper报错

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/760366.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号