概要 - 方法 - レシピ¶
一般的に、または頻繁に尋ねられる質問に関するドキュメントの他の場所へのいくつかのポインタを以下に示します。
データのフィルタリング - セキュリティ¶
必要以上のデータが返されないようにするには、チュートリアル - レスポンスモデル - 戻り値のドキュメントを参照してください。
ドキュメントタグ - OpenAPI¶
パスオペレーションにタグを追加して、ドキュメントUIでグループ化するには、チュートリアル - パスオペレーションの設定 - タグのドキュメントを参照してください。
ドキュメントのサマリーと説明 - OpenAPI¶
パスオペレーションにサマリーと説明を追加して、ドキュメントUIに表示するには、チュートリアル - パスオペレーションの設定 - サマリーと説明のドキュメントを参照してください。
ドキュメントレスポンスの説明 - OpenAPI¶
ドキュメントUIに表示されるレスポンスの説明を定義するには、チュートリアル - パスオペレーションの設定 - レスポンスの説明のドキュメントを参照してください。
ドキュメントパスオペレーションの非推奨化 - OpenAPI¶
パスオペレーションを非推奨にし、ドキュメントUIに表示するには、チュートリアル - パスオペレーションの設定 - 非推奨化のドキュメントを参照してください。
任意のデータをJSON互換に変換する¶
任意のデータをJSON互換に変換するには、チュートリアル - JSON互換エンコーダーのドキュメントを参照してください。
OpenAPIメタデータ - ドキュメント¶
ライセンス、バージョン、連絡先情報など、OpenAPIスキーマにメタデータを追加するには、チュートリアル - メタデータとドキュメントURLのドキュメントを参照してください。
OpenAPIカスタムURL¶
OpenAPI URLをカスタマイズする(または削除する)には、チュートリアル - メタデータとドキュメントURLのドキュメントを参照してください。
OpenAPIドキュメントURL¶
自動生成されたドキュメントユーザーインターフェースで使用されるURLを更新するには、チュートリアル - メタデータとドキュメントURLのドキュメントを参照してください。