Pontx Hub 是做什麼的?
使用 pontx-hub 作為權威的介面來使用精心策劃的 API 目錄。僅搜尋並載入當前任務所需的產品、端點或結構,以將 API 元資料保留在長期上下文之外。
工作流程
-
在選擇 API 前先進行搜尋。支援自然語言查詢、功能描述、請求和回應相關問題:
pontx-hub search "<capability>" --json pontx-hub search "創建任務的入參" --locale zh --json pontx-hub search "返回 dueDate 的介面" --locale zh --json必要時縮小結果類型:
pontx-hub search "<field-or-model>" --type schema --json -
檢查選定的穩定資源 ID:
pontx-hub show endpoint:<api>/<endpoint> pontx-hub show schema:<api>/<schema> -
對於端點,建立並檢視確切的請求內容而不實際發送:
pontx-hub <api-collection> preview <api-name> --parameter value --body '<json>' pontx-hub <api-collection> preview <controller> <api-name> --parameter value --body '<json>' -
對於 GET 或 HEAD 方法,僅在使用者要求執行時才呼叫:
pontx-hub <api-collection> call <api-name> --parameter value pontx-hub <api-collection> call <controller> <api-name> --parameter value -
對於 POST、PUT、PATCH 或 DELETE 方法,先顯示乾執行結果並取得使用者明確確認,然後在不改變參數的情況下傳遞
--yes:pontx-hub <api-collection> call <controller> <api-name> --parameter value --body '<json>' --yes -
在請求結構驗證後產生整合程式碼:
pontx-hub sdk <api>
安全性
- 絕不能從檢查、解釋或預覽 API 的請求中推斷出對寫入操作的核准。
- 絕不能將憑證直接列印、輸出、記錄或放置在命令引數中。
- 從
show命名的環境變數讀取憑證。 - 絕不能呼叫 Hub 目錄之外的任意 URL 或操作。
- 對任何修改操作都不得跳過單獨的
preview步驟。 - 將已變更的參數、請求主體、伺服器或操作視為新請求,需要再次進行乾執行和確認。
- 在設定憑證、診斷驗證或執行修改操作時,請閱讀 references/auth-and-safety.md。
輸出
當以程式方式使用 CLI 輸出時,建議使用 --json。在報告失敗時,保留 CLI 的退出代碼和機器可讀的錯誤代碼。使用結果的 match.mode 和 match.fields 來解釋匹配是來自產品、參數、請求、回應、結構還是屬性元資料。在產生應用程式碼時,使用該操作已發佈的 @pontx/<api-slug> 套件。