### 关于API服务的根路径 当使用Swagger UI来展示API文档时，通常需要指定API的服务根路径（base URL），这是所有Swagger资源被提供服务的基础位置。如果无法自动推断基础URL，则可能是因为动态Servlet注册或者API位于API网关之后的情况所致[^1]。在这种情况下，可以手动输入基础URL的位置。 例如，假设API可以通过 `http://example.org/api/v2/api-docs` 访问，那么其基础URL应为 `http://example.org/api/`。这一步骤对于确保Swagger能够正确加载并渲染API文档至关重要。 --- ### 如何访问Swagger UI界面 为了查看由Swagger生成的可视化API文档，在浏览器中可以直接访问特定路径。如果是本地运行Spring Boot项目，默认可以在以下地址找到Swagger UI页面： ```plaintext http://localhost:8080/swagger-ui.html ``` 需要注意的是，某些较高版本的Swagger可能会更改默认文件名，因此也可能需要访问如下路径： ```plaintext http://<your-server>:<port>/swagger-ui/index.html ``` 上述路径中的 `<your-server>` 和 `<port>` 需要替换为实际部署环境对应的服务器地址和端口号[^2]。 --- ### Swagger UI的工作原理 Swagger UI是一个开源工具，用于直观地呈现基于Swagger定义的API文档。它通过从指定的文档地址请求数据，并将返回的JSON格式的数据转换为易于理解的图形化界面[^3]。具体过程分为两个主要阶段： 1. **文档地址**: 请求API的描述信息（通常是JSON格式），这些信息存储在类似于 `/v2/api-docs` 的路径下。 2. **API文档显示**: 将获取到的JSON数据解析后转化为交互式的HTML页面，方便开发者测试和查阅API接口的功能与参数。 这种机制使得开发人员无需阅读复杂的文本说明即可快速掌握API的具体实现细节。 --- ### Spring Boot集成Swagger UI示例 以下是配置Spring Boot项目以支持Swagger UI的一个简单代码片段： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } } ``` 此代码片段展示了如何创建一个Docket Bean实例，该实例负责扫描指定包下的控制器类，并自动生成相应的API文档[^4]。 ---