# Path Operationの設定 *path operationデコレータ*を設定するためのパラメータがいくつかあります。 /// warning | "注意" これらのパラメータは*path operation関数*ではなく、*path operationデコレータ*に直接渡されることに注意してください。 /// ## レスポンスステータスコード *path operation*のレスポンスで使用する(HTTP)`status_code`を定義することができます。 `404`のように`int`のコードを直接渡すことができます。 しかし、それぞれの番号コードが何のためのものか覚えていない場合は、`status`のショートカット定数を使用することができます: ```Python hl_lines="3 17" {!../../docs_src/path_operation_configuration/tutorial001.py!} ``` そのステータスコードはレスポンスで使用され、OpenAPIスキーマに追加されます。 /// note | "技術詳細" また、`from starlette import status`を使用することもできます。 **FastAPI** は開発者の利便性を考慮して、`fastapi.status`と同じ`starlette.status`を提供しています。しかし、これはStarletteから直接提供されています。 /// ## タグ `tags`パラメータを`str`の`list`(通常は1つの`str`)と一緒に渡すと、*path operation*にタグを追加できます: ```Python hl_lines="17 22 27" {!../../docs_src/path_operation_configuration/tutorial002.py!} ``` これらはOpenAPIスキーマに追加され、自動ドキュメントのインターフェースで使用されます: ## 概要と説明 `summary`と`description`を追加できます: ```Python hl_lines="20-21" {!../../docs_src/path_operation_configuration/tutorial003.py!} ``` ## docstringを用いた説明 説明文は長くて複数行におよぶ傾向があるので、関数docstring内に*path operation*の説明文を宣言できます。すると、**FastAPI** は説明文を読み込んでくれます。 docstringにMarkdownを記述すれば、正しく解釈されて表示されます。(docstringのインデントを考慮して) ```Python hl_lines="19-27" {!../../docs_src/path_operation_configuration/tutorial004.py!} ``` これは対話的ドキュメントで使用されます: ## レスポンスの説明 `response_description`パラメータでレスポンスの説明をすることができます。 ```Python hl_lines="21" {!../../docs_src/path_operation_configuration/tutorial005.py!} ``` /// info | "情報" `respnse_description`は具体的にレスポンスを参照し、`description`は*path operation*全般を参照していることに注意してください。 /// /// check | "確認" OpenAPIは*path operation*ごとにレスポンスの説明を必要としています。 そのため、それを提供しない場合は、**FastAPI** が自動的に「成功のレスポンス」を生成します。 /// ## 非推奨の*path operation* *path operation*をdeprecatedとしてマークする必要があるが、それを削除しない場合は、`deprecated`パラメータを渡します: ```Python hl_lines="16" {!../../docs_src/path_operation_configuration/tutorial006.py!} ``` 対話的ドキュメントでは非推奨と明記されます: *path operations*が非推奨である場合とそうでない場合でどのように見えるかを確認してください: ## まとめ *path operationデコレータ*にパラメータを渡すことで、*path operations*のメタデータを簡単に設定・追加することができます。