yml 配置 springfox

YML（YAML）配置Springfox是一种常见的做法，用于自定义Swagger（API文档生成工具）的行为和外观。Springfox是一个用于注解驱动的RESTful API文档生成库，它允许你在YAML文件中详细配置Swagger UI、API路径扫描、数据模型映射等。

以下是使用YAML配置Springfox的基本步骤：

1. 添加依赖：首先在你的Maven或Gradle构建文件中添加Springfox及其相关依赖，例如：

dependencies {
    implementation 'io.springfox:springfox-boot-starter:3.0.0-M5'
}

2. 创建YML文件：通常放在`application.yml`或`application.properties`里，并命名为`swagger-*.yml`，以便Spring Boot自动发现并加载。

3. 配置基础设置：如标题、描述和版本信息，示例：

springfox:
  swagger-ui:
    location: /api-docs
    configUrl: /v2/api-docs
  info:
    title: My API
    description: A sample API using Swagger with Springfox
    version: 1.0.0

4. 配置API路径扫描：指定哪些包或控制器需要扫描以提取API定义，如：

paths:
  include: 
    - '/api/**'
  exclude: []

5. 数据模型映射：如果你有复杂的实体类，可以配置模型别名（model names）：

components:
  schemas:
    User:
      $ref: '#/components/schemas/UserModel'

6. 自定义全局装饰器：可以定义全局的Swagger响应或请求处理器，如认证信息。