跳转到内容

导入 API

Restorm 可识别 二十四种格式,并据此重建一棵完整的项目树:文件夹、请求、环境、 API 文档、枚举。

这几乎总是最好的起点:如果已经存在一份规范,就不要手写请求。

文件 ▸ 导入Ctrl+I)接受:

  • 磁盘上的文件
  • 一个 URL —— 适用于在线提供的 swagger.json$metadata
  • 粘贴的内容 —— 把一条 curl 命令变成请求就是这样做的。

Restorm 会自动识别格式:先看文件扩展名,再分析内容。您无需做任何选择。

“导入请求”模态框:可粘贴路径、URL 或 curl 命令的单一输入框,身份验证路由、固定请求头和 gRPC reflection 按钮,拖放区域,以及被突出显示的格式卡片

格式页面
OpenAPI 3.x 与 Swagger 2.0OpenAPI / Swagger
GraphQL 模式(SDL)GraphQL
.proto 文件与 gRPC reflectiongRPC
WSDLSOAP / WSDL
AsyncAPIAsyncAPI
OData EDMX / CSDLOData
OpenRPCOpenRPC
tRPC 模式tRPC
SmithySmithy
TypeSpecTypeSpec
RAMLRAML
WADLWADL
ThriftThrift
API BlueprintAPI Blueprint
格式页面
PostmanPostman
InsomniaInsomnia
BrunoBruno
Thunder ClientThunder Client
Paw / RapidAPIPaw
HTTPieHTTPie
VS Code REST Client(.httpREST Client
格式页面
HAR(浏览器抓包)HAR
curl 命令cURL
Invoke-RestMethod / Invoke-WebRequestPowerShell

取决于源格式的丰富程度:

  • 一个环境文件夹,包含一个或多个环境,基础 URL 从规范中提取;
  • 一棵文件夹树 —— 按标签、按服务或按资源组织,取决于格式;
  • 每个操作一个请求,类型与其协议相对应;
  • 附加在该文件夹上的 API 文档:模型、描述、安全方案、示例响应;
  • 规范中的枚举,可作为值类型复用;
  • 预先接好的身份验证请求头及其变量 —— 参见 身份验证

导入完成后,凡是取值解析为空的键 / 值对都会被自动禁用:因此您的第一次发送不会 带上一大堆空请求头。

一次导入不只产出请求:它还保留 API 的文档 —— 描述、模型、安全、示例、枚举 —— 可在所创建文件夹的 文档 标签页中查阅。参见 访问并更新已导入 API 的文档

有十二种格式支持重新同步:Restorm 会把源的新版本与现有的树进行比较并应用差异, 不会丢失您的修改。参见 从源更新

Restorm 会为每个请求生成代码片段,覆盖其协议所有相关的语言。参见 代码导出