SpringBoot访问doc.html页面404

如果你在Spring Boot项目中配置了 Swagger UI 并尝试访问 doc.html 页面遇到404错误,这通常意味着几个潜在的问题。下面是一些排查和解决步骤:

  1. 确认依赖是否正确添加
    确保你的pom.xml(如果是Maven项目)或build.gradle(如果是Gradle项目)中已经包含了Swagger相关的依赖。对于Springfox(一个常用的Swagger实现),Maven依赖示例如下:

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version> <!-- 请检查并使用最新或适用版本 -->
    </dependency>
    

    如果你正在使用的是Swagger-UI和Swagger2的组合,确保相应的依赖也已添加。

  2. 检查配置类
    确保你有正确的配置类来设置Swagger。一个基础的配置类示例可能如下:

    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        @Bean
        public Docket api() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .select()
                    .apis(RequestHandlerSelectors.any())
                    .paths(PathSelectors.any())
                    .build();
        }
    }
    

    对于Springfox 3.x及以上版本,可能需要使用OpenAPI替代:

    @Configuration
    public class SwaggerConfig {
        @Bean
        public OpenAPI customOpenAPI() {
            return new OpenAPI()
                    .info(new Info().title("Your API Title").version("1.0.0").description("API description"));
        }
    }
    
  3. 访问路径确认
    Swagger UI默认访问路径通常是 /swagger-ui.html/swagger-ui/index.html,而不是 doc.html。请尝试直接访问这些默认路径。如果你自定义了路径,请确保按照你的配置来访问。

  4. 检查Spring Boot应用的配置
    确保没有安全配置或其他配置阻止了对Swagger UI的访问。例如,如果你使用了Spring Security,可能需要明确允许对Swagger UI的访问:

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
                .antMatchers("/v2/api-docs", "/configuration/ui", "/swagger-resources", 
                             "/configuration/security", "/swagger-ui.html", "/webjars/**")
                .permitAll()
                // 其他配置...
    }
    
  5. 查看日志
    检查Spring Boot启动时的日志输出,看是否有Swagger相关的错误或警告信息,这可能会给出404问题的线索。

如果以上步骤都确认无误但问题依旧,可能需要检查项目的特定配置或者是否存在版本兼容性问题。考虑到技术的快速发展,查阅最新的官方文档或社区讨论也是解决问题的好方法。

  • 17
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值