Springboot下swagger-ui.html访问不到的解决方案

下面是“Springboot下swagger-ui.html访问不到的解决方案”的完整攻略。

问题描述

在使用Springboot开发Web应用时，有时候会发现启动应用后访问http://localhost:port/swagger-ui.html时，会提示“404找不到页面”的错误信息。这种情况下，我们无法使用Swagger来做API文档管理和调试。

解决方案

在Springboot的配置文件（如application.yml或application.properties）中，需要增加一条配置，启用Swagger的相关功能。具体配置如下：

# Swagger配置
swagger:
  enabled: true # 启用Swagger功能
  title: Swagger UI # 网站标题
  description: Swagger UI for API testing # 网站描述
  version: 1.0.0 # 版本号
  base-package: com.example.demo # Spring自动扫描的包路径

配置说明：

• enabled：是否启用Swagger功能
• title：Swagger网站的标题
• description：Swagger网站的描述信息
• version：API版本号，一般为“1.0.0”格式的字符串
• base-package：Spring自动扫描的包路径，用于将包中的所有API接口自动生成到Swagger网站中

在完成配置后，重新启动Springboot应用即可访问http://localhost:port/swagger-ui.html接口文档管理首页。

示例说明

以一个简单的Springboot Web应用为例，说明如何配置Swagger：

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

在上面的代码中，我们定义了一个名为“DemoApplication”的Springboot启动类，在main函数中调用SpringApplication.run方法来启动应用。

在src/main/java/com/example/demo/controller/TodoController.java中，定义了API接口：

package com.example.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@RestController
@RequestMapping("/api/todo")
@Api(tags = "Todo API")
public class TodoController {
    @ApiOperation(value = "获取Todo列表", notes = "获取所有Todo")
    @RequestMapping("/")
    public String list() {
        return "Todo List";
    }
}

在上面的代码中，我们定义了一个名为“TodoController”的API接口类，使用@RestController注解标记为一个RestController，使用@RequestMapping注解标记访问路径为“/api/todo”。同时，我们使用@ApiOperation注解标记了list方法的功能，并使用@Api注解标记了类级别的API信息。

在完成上述代码的编写后，在配置文件application.yml中增加相关配置：

swagger:
  enabled: true
  title: Springboot Demo
  description: This is a demo RESTful API
  version: 1.0.0
  base-package: com.example.demo

在完成配置后，重新启动应用，并访问http://localhost:port/swagger-ui.html，就可以看到自动生成的API文档页面。

总结

以上就是“Springboot下swagger-ui.html访问不到的解决方案”的完整攻略，通过在配置文件中增加Swagger相关配置，我们可以轻松地启用Swagger功能，并在API调试和测试时提高开发效率。