跳到主要内容

快速开始

这条简短路径带你走完核心闭环：打开一份规范、通过 AI 助手修改它、发送一次请求，并以文档形式查看结果。一切都使用同一份 OpenAPI 文档。

1. 打开一份规范​

启动客户端，用你手头的任意来源打开规范。以下来源都通过同一个导入流程支持，并会自动转换或升级为 OpenAPI 3.2：

  • 磁盘上的 OpenAPI 或 Swagger 文件（Swagger 2.0 和 OpenAPI 3.0/3.1 会被升级）；
  • 一份 Postman 集合；
  • 一条 cURL 命令；
  • 一个 Git 仓库；
  • 指向某份规范的 URL。

你也可以把文件直接拖入工作区。如果手头没有任何起点，可以让助手根据一段简短描述创建初始骨架。

2. 让助手添加一个接口​

在对话中描述你的需求，例如：

添加一个 GET /products 接口，返回分页的产品列表。

助手会以补丁卡片回应，而不是直接编辑文档。卡片展示它打算改动的操作，以及受影响的路径和资源。审阅后选择应用或拒绝。在你应用之前，不会有任何改动进入文档。

对于"构建一个电商 API"这类宽泛请求，助手会先提出一个澄清问题，然后一次提出聚焦于两到五个操作的补丁。

3. 细化单个操作而不漂移​

打开一个操作并就地细化——例如添加一个查询参数或扩展响应模式。在聚焦模式下，助手会生成精细的补丁，只触及你要求的字段，并保留该操作的其他所有字段。这正是让同一 API 上反复来回的修改不会跑偏或覆盖已有工作的关键。

4. 发送一次真实请求​

切换到该操作的请求工作区并发送。请求通过本地主进程执行。响应、状态、响应头和耗时与操作并排显示，请求工作区支持用环境和变量来管理在不同运行之间变化的值。

如果因为规范的 servers 和当前环境都缺少基础 URL 而无法构建请求，应用会请你提供一个，而不是去猜测。

5. 查看文档​

打开文档，把同一份规范渲染为可读的 API 文档。由于查看器读取的是实时文档，文档始终与你刚刚设计的内容一致。

6. 准备好后再深入​

至此你已经走完了完整闭环。文档的其余部分会深入介绍每个工作区。