swagger yaml配置文件

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。Swagger 文件可以用 JSON 或 YAML 格式编写。YAML 配置文件是 Swagger 规范的一部分，它提供了一种更为简洁和易读的方式来描述 API。

一个基本的 Swagger YAML 配置文件包含以下几个主要部分：

1. `swagger`: 声明 API 的版本。
2. `info`: API 的描述信息，包括标题、版本、描述等。
3. `host`: API 服务器的地址。
4. `basePath`: API 基础路径。
5. `schemes`: API 支持的传输协议，如 http、https 等。
6. `paths`: 定义 API 的路径和操作（GET、POST、PUT、DELETE 等）。
7. `definitions`: 定义请求和响应的数据模型。
8. `parameters`: 定义全局参数。
9. `responses`: 定义全局的响应代码。

下面是一个简单的 Swagger YAML 配置文件示例：

swagger: '2.0'
info:
  version: "1.0.0"
  title: Sample API
  description: A sample API for demonstration purposes
host: localhost:3000
basePath: /api
schemes:
  - https
paths:
  /users:
    get:
      summary: Returns a list of users
      responses:
        200:
          description: An array of users

YAML 文件的优势在于其格式简洁、易于阅读和编辑，因此在描述复杂的 API 结构时显得尤为有用。