swagger3配置

### 如何配置 Swagger 3

#### 使用 Springdoc 库进行配置

为了在应用程序中启用并配置Swagger 3 (OpenAPI 3)，推荐使用 `springdoc` 这一基于 OpenAPI 规范的库来替代传统的 `Springfox`，因为前者提供了更好的性能和支持[^3]。

在项目的 `pom.xml` 文件内加入如下依赖：

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.14</version>
</dependency>

接着，在 `application.properties` 或者 `application.yml` 中设置必要的属性以激活和自定义 API 文档的行为:

对于 `.properties` 文件来说, 可能看起来像这样:

# 启用 Springdoc 自动生成 API 文档
springdoc.api-docs.enabled=true 

# 配置生成的 API 文档的访问路径，默认为 "/v3/api-docs"
springdoc.api-docs.path=/v3/api-docs  

# 配置 Swagger-UI 的访问路径，默认为 "/swagger-ui.html"
springdoc.swagger-ui.path=/swagger-ui.html  

完成以上步骤之后，启动项目，并通过浏览器打开指定地址查看接口文档。通常情况下，如果端口号是默认的话，则可以通过下面链接进入交互式的 API 页面：`http://localhost:8080/swagger-ui.html`。

需要注意的是，不同版本间的差异可能导致具体实现略有区别；例如，在某些特定版本下可能需要调整URL中的端口或者其他参数部分[^4]。