一般 - 如何操作 - 常見範例¶
以下是指向文件中其他位置的一些指標,用於解答一般性或常見問題。
過濾資料 - 安全性¶
為了確保您不會返回比預期更多的資料,請閱讀教學 - 回應模型 - 返回類型的說明文件。
文件標籤 - OpenAPI¶
要將標籤添加到您的路徑操作並在文件 UI 中將它們分組,請閱讀教學 - 路徑操作設定 - 標籤的說明文件。
文件摘要和描述 - OpenAPI¶
要將摘要和描述添加到您的路徑操作並在文件 UI 中顯示它們,請閱讀教學 - 路徑操作設定 - 摘要和描述的說明文件。
文件回應描述 - OpenAPI¶
要定義顯示在文件 UI 中的回應描述,請閱讀教學 - 路徑操作設定 - 回應描述的說明文件。
文件棄用路徑操作 - OpenAPI¶
要棄用路徑操作並在文件 UI 中顯示它,請閱讀教學 - 路徑操作設定 - 棄用的說明文件。
將任何資料轉換為 JSON 相容格式¶
要將任何資料轉換為 JSON 相容格式,請閱讀教學 - JSON 相容編碼器的說明文件。
OpenAPI 中繼資料 - 文件¶
要將中繼資料添加到您的 OpenAPI 結構描述,包括授權、版本、聯絡方式等,請閱讀教學 - 中繼資料和文件網址的說明文件。
OpenAPI 自訂網址¶
要自訂 OpenAPI 網址(或移除它),請閱讀教學 - 中繼資料和文件網址的說明文件。
OpenAPI 文件網址¶
要更新用於自動產生的文件使用者介面的網址,請閱讀教學 - 中繼資料和文件網址的說明文件。