先決條件#
API 文件:在端點請求/回應 schema 中命名欄位
Schemas:在可重複使用的 schema 定義中命名欄位
Components:在 component schemas 中命名欄位
AI 可以根據你在目前 API 文件中對特定欄位的描述,並依據 API 設計指南,產生標準化、專業且易於閱讀的欄位名稱。使用 AI 驅動的欄位命名#
步驟 1:找到 AI 命名圖示#
你會在 API 文件、schemas 或 components 中的每個欄位旁看到 AI 命名圖示。點擊該圖示即可開始 AI 命名流程。步驟 2:提供欄位描述#
點擊 AI 命名圖示後,會出現提示。輸入該欄位的簡短描述,引導 AI 產生合適的欄位名稱。你也可以選擇不同的 AI 模型。如果你已經填寫欄位描述,系統會自動使用該描述。步驟 3:審閱 AI 產生的名稱#
點擊 Send,AI 會根據 API 設計指南、目前文件內容脈絡以及欄位描述,產生多個欄位名稱。它也會為每個名稱提供說明與評分。步驟 4:套用你偏好的名稱#
你可以選擇其中一個 AI 產生的欄位名稱,並點擊 Adopt 將其直接套用到文件中。Modified at 2026-06-11 10:26:02