Swagger API 文档 | SpringDoc 配置项

在Spring项目中使用SpringDoc来生成Swagger API文档，可以通过配置文件来定制Swagger的行为。以下是一些常见的SpringDoc配置项：

1. 基础配置：

springdoc:
  api-docs:
    enabled: true
  swagger-ui:
    enabled: true

2. 自定义API文档分组：

springdoc:
  groups:
    group1:
      pathsToMatch: /v2/api/**
      packagesToScan: com.example.controller1
    group2:
      pathsToMatch: /v2/admin/**
      packagesToScan: com.example.controller2

3. 自定义API文档的标题、描述和版本：

springdoc:
  api-info:
    title: My Custom API Title
    description: My Custom API Description
    version: 1.0.0

4. 安全设置，指定需要的权限才能访问Swagger UI：

springdoc:
  swagger-ui:
    security:
      - basicAuth: []

5. 配置API文档的扫描路径和扫描的包路径：

springdoc:
  packagesToScan:
    - com.example.controller1
    - com.example.controller2

6. 配置API文档的路径：

springdoc:
  api-docs:
    path: /custom/api-docs

7. 配置Swagger UI的路径：

springdoc:
  swagger-ui:
    path: /custom/swagger-ui.html

这些配置项可以根据项目的具体需求进行调整和增减。在代码中，通常会在application.yml或application.properties文件中添加这些配置。