在使用 Swagger 时,您可以使用多个 JSON 文件来定义不同的 API 接口。您可以按照以下步骤将 Swagger 分成多个文件:

  1. 在您的项目中创建一个名为 'swagger' 的文件夹。

  2. 在该文件夹中,创建一个名为 'swagger.json' 的文件,用于定义您的 API 文档的基本信息。

  3. 在该文件夹中,创建一个名为 'api' 的文件夹,用于存储您的 API 接口定义文件。

  4. 在 'api' 文件夹中,为每个不同的请求路径创建一个 JSON 文件,例如 'users.json' 或 'orders.json'。

  5. 在每个 JSON 文件中,定义该请求路径下的所有 API 接口。

  6. 在 'swagger.json' 文件中,使用 '$ref' 关键字引用每个 API 接口定义文件。

例如,您可以在 'swagger.json' 中使用以下代码段引用 'users.json' 文件中的 API 接口:

{
  "swagger": "2.0",
  "info": {
    "title": "My API",
    "version": "1.0.0"
  },
  "paths": {
    "/users": {
      "$ref": "api/users.json"
    }
  }
}

这样,您就可以将 Swagger 分成多个文件,以便更好地组织和管理您的 API 接口定义。


原文地址: https://www.cveoy.top/t/topic/lEw0 著作权归作者所有。请勿转载和采集!

免费AI点我,无需注册和登录