导入 OpenAPI / Swagger

这是 Restorm 最完整的一种导入。可识别三个版本：Swagger 2.0、OpenAPI 3.0 和 OpenAPI 3.1。

导入

文件 ▸ 导入（Ctrl+I），然后选择一个 swagger.json / openapi.json 文件，或直接填入规范的 URL。

如果该 URL 返回 401 或 403，Restorm 会建议您附加一个身份验证并重试，无需离开 导入模态框。

导入了什么

规范中的元素	Restorm 如何处理
servers（或 host + basePath + schemes）	环境的基础 URL，服务器变量已解析
tags	每个标签一个文件夹，其余内容放入 Other 文件夹
每个操作	一个 HTTP 请求，包含方法和路径
参数	路径参数、查询参数和请求头，均带类型（字符串、数字、日期时间、枚举、密钥……）
requestBody	正文，采用其内容类型
examples	用所提供的示例预填正文
components / definitions	API 文档：模型、描述
enum	可作为值类型复用的枚举
响应	按内容类型记入文档

$ref 会被解析，包括跨组件的引用。

components / definitions 这一行值得强调：导入并不局限于请求，它保留了 API 的 全部文档 —— 描述、模型、安全方案、示例、枚举。这些内容既可在导入生成的环境文件夹 的 文档 标签页中查阅，也可在每个请求的对应标签页中查阅，并且可以从源重新同步。 参见 访问并更新已导入 API 的文档。

安全

所声明的安全方案会被转换为预先接好的请求头或参数，并为您创建相应的环境变量：

方案	Restorm 生成的内容
位于请求头或查询中的 apiKey	一个以该方案命名的键值对，值为 {{<schema>}}
http + basic	Authorization: Basic {{<schema>_credentials}}
http + bearer、oauth2、openIdConnect	Authorization: Bearer {{<schema>_token}}

接下来只需填写该变量 —— 或者把它替换成一条 身份验证路由，从而获得令牌的自动续期。

已知限制

通过 cookie 传递的 apiKey 不会被预先接好（OpenAPI 3）。 被引用但未声明的安全方案会被静默忽略。

更新

OpenAPI 和 Swagger 属于可重新同步的格式：文件夹的刷新按钮会重新获取源，然后 Restorm 应用差异 —— 新增的操作会被添加，消失的操作会被标记为已弃用而不是删除， 您的修改则被保留。参见 从源更新。