跳至主要内容

快速開始

這條簡短路徑帶你走完核心閉環：打開一份規範、透過 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. 準備好後再深入​

至此你已經走完了完整閉環。文件的其餘部分會深入介紹每個工作區。