コンテンツへスキップ

全般 - 方法 - レシピ

ここでは、一般的または頻繁な質問に対するドキュメントの他の箇所へのポインタをいくつか示します。

データのフィルタリング - セキュリティ

必要以上にデータを返さないようにするには、チュートリアル - レスポンスモデル - 戻り値の型 のドキュメントをお読みください。

ドキュメントタグ - OpenAPI

パス操作 にタグを追加し、ドキュメントUIでグループ化するには、チュートリアル - パス操作の設定 - タグ のドキュメントをお読みください。

ドキュメントの概要と説明 - OpenAPI

パス操作 に概要と説明を追加し、ドキュメントUIで表示するには、チュートリアル - パス操作の設定 - 概要と説明 のドキュメントをお読みください。

ドキュメントのレスポンス説明 - OpenAPI

ドキュメントUIに表示されるレスポンスの説明を定義するには、チュートリアル - パス操作の設定 - レスポンスの説明 のドキュメントをお読みください。

ドキュメントで パス操作 を非推奨にする - OpenAPI

パス操作 を非推奨にし、ドキュメントUIに表示するには、チュートリアル - パス操作の設定 - 非推奨 のドキュメントをお読みください。

あらゆるデータをJSON互換に変換する

あらゆるデータをJSON互換に変換するには、チュートリアル - JSON互換エンコーダ のドキュメントをお読みください。

OpenAPI メタデータ - ドキュメント

ライセンス、バージョン、連絡先などを含むメタデータをOpenAPIスキーマに追加するには、チュートリアル - メタデータとドキュメントURL のドキュメントをお読みください。

OpenAPI カスタムURL

OpenAPI URLをカスタマイズする(または削除する)には、チュートリアル - メタデータとドキュメントURL のドキュメントをお読みください。

OpenAPI ドキュメントURL

自動生成されたドキュメントのユーザーインターフェースに使用されるURLを更新するには、チュートリアル - メタデータとドキュメントURL のドキュメントをお読みください。