3.5 KiB
一般 - ハウツー - レシピ
ここでは、一般的またはよくある質問に対して、ドキュメント内の他の箇所への参照をいくつか示します。
データのフィルタリング - セキュリティ
返すべき以上のデータを返さないようにするには、チュートリアル - レスポンスモデル - 戻り値の型 を参照してください。
レスポンス性能の最適化 - レスポンスモデル - 戻り値の型
JSON データを返す際の性能を最適化するには、戻り値の型またはレスポンスモデルを使用してください。そうすることで、Pydantic が Python を経由せずに Rust 側で JSON へのシリアライズを処理します。詳細は チュートリアル - レスポンスモデル - 戻り値の型 を参照してください。
ドキュメントのタグ - OpenAPI
path operations にタグを追加し、ドキュメント UI でグループ化するには、チュートリアル - path operation の設定 - タグ を参照してください。
ドキュメントの概要と説明 - OpenAPI
path operations に概要と説明を追加し、ドキュメント UI に表示するには、チュートリアル - path operation の設定 - 概要と説明 を参照してください。
ドキュメントのレスポンス説明 - OpenAPI
ドキュメント UI に表示されるレスポンスの説明を定義するには、チュートリアル - path operation の設定 - レスポンスの説明 を参照してください。
Path Operation の非推奨化 - OpenAPI
path operation を非推奨にし、ドキュメント UI に表示するには、チュートリアル - path operation の設定 - 非推奨 を参照してください。
任意のデータを JSON 互換に変換
任意のデータを JSON 互換に変換するには、チュートリアル - JSON 互換エンコーダ を参照してください。
OpenAPI メタデータ - ドキュメント
ライセンス、バージョン、連絡先などを含むメタデータを OpenAPI スキーマに追加するには、チュートリアル - メタデータとドキュメントの URL を参照してください。
OpenAPI のカスタム URL
OpenAPI の URL をカスタマイズ（または削除）するには、チュートリアル - メタデータとドキュメントの URL を参照してください。
OpenAPI ドキュメントの URL
自動生成されるドキュメント UI が使用する URL を変更するには、チュートリアル - メタデータとドキュメントの URL を参照してください。