通用 - 操作指南 - 實用範例

🌐 AI 與人類共同完成的翻譯

此翻譯由人類指導的 AI 完成。🤝

可能會有對原意的誤解，或讀起來不自然等問題。🤖

你可以透過協助我們更好地引導 AI LLM來改進此翻譯。

英文版

以下是文件中其他位置的指引連結，適用於一般或常見問題。

篩選資料 - 安全性

為確保你不會回傳超出應有的資料，請參閱教學 - 回應模型 - 回傳型別。

文件標籤 - OpenAPI

要在你的路徑操作（path operation）加入標籤，並在文件 UI 中分組，請參閱教學 - 路徑操作設定 - 標籤。

文件摘要與描述 - OpenAPI

要為你的路徑操作加入摘要與描述，並在文件 UI 中顯示，請參閱教學 - 路徑操作設定 - 摘要與描述。

文件回應描述 - OpenAPI

要定義在文件 UI 中顯示的回應描述，請參閱教學 - 路徑操作設定 - 回應描述。

文件將路徑操作標記為已棄用 - OpenAPI

要將路徑操作標記為已棄用，並在文件 UI 中顯示，請參閱教學 - 路徑操作設定 - 棄用。

將任意資料轉換為 JSON 相容格式

要將任意資料轉換為 JSON 相容格式，請參閱教學 - JSON 相容編碼器。

OpenAPI 中繼資料 - 文件

要在你的 OpenAPI 綱要中加入中繼資料（包含授權、版本、聯絡方式等），請參閱教學 - 中繼資料與文件 URL。

自訂 OpenAPI URL

要自訂（或移除）OpenAPI 的 URL，請參閱教學 - 中繼資料與文件 URL。

OpenAPI 文件 URL

要更新自動產生的文件使用者介面所使用的 URL，請參閱教學 - 中繼資料與文件 URL。