diff --git a/docs/ja/docs/_llm-test.md b/docs/ja/docs/_llm-test.md
new file mode 100644
index 000000000..b3d9fc28c
--- /dev/null
+++ b/docs/ja/docs/_llm-test.md
@@ -0,0 +1,503 @@
+# LLM テストファイル { #llm-test-file }
+
+このドキュメントは、ドキュメントを翻訳する LLM が、`scripts/translate.py` の `general_prompt` と、`docs/{language code}/llm-prompt.md` の言語固有プロンプトを理解しているかをテストします。言語固有プロンプトは `general_prompt` の末尾に追加されます。
+
+ここに追加したテストは、すべての言語固有プロンプトの設計者が参照します。
+
+使い方:
+
+* 言語固有プロンプトを用意します - `docs/{language code}/llm-prompt.md`。
+* この文書を希望するターゲット言語に新規で翻訳します(例: `translate.py` の `translate-page` コマンド)。これにより `docs/{language code}/docs/_llm-test.md` に翻訳が作成されます。
+* 翻訳が問題ないか確認します。
+* 必要であれば、言語固有プロンプト、general プロンプト、または英語ドキュメントを改善します。
+* その後、翻訳に残っている問題を手動で修正し、良い翻訳にします。
+* 良い翻訳を用意した状態でもう一度翻訳します。理想的な結果は、LLM が翻訳に一切変更を加えないことです。つまり general プロンプトと言語固有プロンプトが最良であることを意味します(時々いくつかランダムに見える変更を行うことがあります。理由は LLM は決定論的アルゴリズムではない ためです)。
+
+テスト内容:
+
+## コードスニペット { #code-snippets }
+
+//// tab | テスト
+
+これはコードスニペットです: `foo`。そしてこれもコードスニペットです: `bar`。さらにもう一つ: `baz quux`。
+
+////
+
+//// tab | 情報
+
+コードスニペットの内容はそのままにしておく必要があります。
+
+`scripts/translate.py` の general プロンプト内「### Content of code snippets」の節を参照してください。
+
+////
+
+## 引用 { #quotes }
+
+//// tab | テスト
+
+昨日、友人はこう書きました。「incorrectly を正しく綴れば、あなたはそれを間違って綴ったことになる」。それに対して私はこう答えました。「そのとおり。ただし『incorrectly』は誤りで、『"incorrectly"』ではありません」。
+
+/// note | 備考
+
+LLM はおそらくここを誤って翻訳します。重要なのは、再翻訳時に修正済みの翻訳を維持できるかどうかだけです。
+
+///
+
+////
+
+//// tab | 情報
+
+プロンプト設計者は、ストレートクォートをタイポグラフィックな引用符に変換するかどうかを選べます。そのままでも問題ありません。
+
+例として `docs/de/llm-prompt.md` の「### Quotes」の節を参照してください。
+
+////
+
+## コードスニペット内の引用 { #quotes-in-code-snippets }
+
+//// tab | テスト
+
+`pip install "foo[bar]"`
+
+コードスニペット中の文字列リテラルの例: `"this"`, `'that'`.
+
+難しい文字列リテラルの例: `f"I like {'oranges' if orange else "apples"}"`
+
+ハードコア: `Yesterday, my friend wrote: "If you spell incorrectly correctly, you have spelled it incorrectly". To which I answered: "Correct, but 'incorrectly' is incorrectly not '"incorrectly"'"`
+
+////
+
+//// tab | 情報
+
+... ただし、コードスニペット内の引用符はそのままにしておく必要があります。
+
+////
+
+## コードブロック { #code-blocks }
+
+//// tab | テスト
+
+Bash のコード例です...
+
+```bash
+# 宇宙にあいさつを表示
+echo "Hello universe"
+```
+
+...そしてコンソールのコード例です...
+
+```console
+$ fastapi run main.py
+ FastAPI Starting server
+ Searching for package file structure
+```
+
+...さらに別のコンソールのコード例です...
+
+```console
+// ディレクトリ "code" を作成
+$ mkdir code
+// そのディレクトリに移動
+$ cd code
+```
+
+...そして Python のコード例です...
+
+```Python
+wont_work() # これは動作しません 😱
+works(foo="bar") # これは動作します 🎉
+```
+
+...以上です。
+
+////
+
+//// tab | 情報
+
+コードブロック内のコードは、コメントを除き、変更してはいけません。
+
+`scripts/translate.py` の general プロンプト内「### Content of code blocks」の節を参照してください。
+
+////
+
+## タブと色付きボックス { #tabs-and-colored-boxes }
+
+//// tab | テスト
+
+/// info | 情報
+いくつかのテキスト
+///
+
+/// note | 備考
+いくつかのテキスト
+///
+
+/// note | 技術詳細
+いくつかのテキスト
+///
+
+/// check | 確認
+いくつかのテキスト
+///
+
+/// tip | 豆知識
+いくつかのテキスト
+///
+
+/// warning | 注意
+いくつかのテキスト
+///
+
+/// danger | 警告
+いくつかのテキスト
+///
+
+////
+
+//// tab | 情報
+
+タブおよび `Info`/`Note`/`Warning` などのブロックには、タイトルの翻訳を縦棒(`|`)の後ろに追加します。
+
+`scripts/translate.py` の general プロンプト内「### Special blocks」と「### Tab blocks」の節を参照してください。
+
+////
+
+## Web リンクと内部リンク { #web-and-internal-links }
+
+//// tab | テスト
+
+リンクのテキストは翻訳し、リンク先のアドレスは変更しないでください:
+
+* [上の見出しへのリンク](#code-snippets)
+* [内部リンク](index.md#installation){.internal-link target=_blank}
+* 外部リンク
+* スタイルへのリンク
+* スクリプトへのリンク
+* 画像へのリンク
+
+リンクのテキストは翻訳し、リンク先のアドレスは翻訳版を指すようにしてください:
+
+* FastAPI リンク
+
+////
+
+//// tab | 情報
+
+リンクのテキストは翻訳し、アドレスは変更しないでください。例外は、FastAPI ドキュメントのページへの絶対 URL です。その場合は翻訳版へのリンクにします。
+
+`scripts/translate.py` の general プロンプト内「### Links」の節を参照してください。
+
+////
+
+## HTML "abbr" 要素 { #html-abbr-elements }
+
+//// tab | テスト
+
+ここでは HTML の "abbr" 要素で包まれたものをいくつか示します(いくつかは架空です):
+
+### abbr が完全な語句を示す { #the-abbr-gives-a-full-phrase }
+
+* GTD
+* lt
+* XWT
+* PSGI
+
+### abbr が完全な語句と説明を示す { #the-abbr-gives-a-full-phrase-and-an-explanation }
+
+* MDN
+* I/O.
+
+////
+
+//// tab | 情報
+
+"abbr" 要素の "title" 属性は特定の指示に従って翻訳します。
+
+翻訳は、英語の語を説明するために独自の "abbr" 要素を追加してもよく、LLM はそれらを削除してはいけません。
+
+`scripts/translate.py` の general プロンプト内「### HTML abbr elements」の節を参照してください。
+
+////
+
+## HTML "dfn" 要素 { #html-dfn-elements }
+
+* クラスター
+* ディープラーニング
+
+## 見出し { #headings }
+
+//// tab | テスト
+
+### Web アプリを開発する - チュートリアル { #develop-a-webapp-a-tutorial }
+
+こんにちは。
+
+### 型ヒントとアノテーション { #type-hints-and-annotations }
+
+またこんにちは。
+
+### スーパークラスとサブクラス { #super-and-subclasses }
+
+またこんにちは。
+
+////
+
+//// tab | 情報
+
+見出しに関する唯一の厳格なルールは、リンクが壊れないように、LLM が中括弧内のハッシュ部分を変更しないことです。
+
+`scripts/translate.py` の general プロンプト内「### Headings」の節を参照してください。
+
+言語固有の指示については、例として `docs/de/llm-prompt.md` の「### Headings」の節を参照してください。
+
+////
+
+## ドキュメントで使う用語 { #terms-used-in-the-docs }
+
+//// tab | テスト
+
+* you
+* your
+
+* e.g.
+* etc.
+
+* `foo` を `int` として
+* `bar` を `str` として
+* `baz` を `list` として
+
+* チュートリアル - ユーザーガイド
+* 上級ユーザーガイド
+* SQLModel ドキュメント
+* API ドキュメント
+* 自動生成ドキュメント
+
+* データサイエンス
+* ディープラーニング
+* 機械学習
+* 依存性注入
+* HTTP Basic 認証
+* HTTP Digest
+* ISO 形式
+* JSON Schema 規格
+* JSON スキーマ
+* スキーマ定義
+* Password Flow
+* モバイル
+
+* 非推奨
+* 設計された
+* 無効
+* オンザフライ
+* 標準
+* デフォルト
+* 大文字小文字を区別
+* 大文字小文字を区別しない
+
+* アプリケーションを提供する
+* ページを配信する
+
+* アプリ
+* アプリケーション
+
+* リクエスト
+* レスポンス
+* エラーレスポンス
+
+* path operation
+* path operation デコレータ
+* path operation 関数
+
+* ボディ
+* リクエストボディ
+* レスポンスボディ
+* JSON ボディ
+* フォームボディ
+* ファイルボディ
+* 関数本体
+
+* パラメータ
+* ボディパラメータ
+* パスパラメータ
+* クエリパラメータ
+* Cookie パラメータ
+* ヘッダーパラメータ
+* フォームパラメータ
+* 関数パラメータ
+
+* イベント
+* 起動イベント
+* サーバーの起動
+* シャットダウンイベント
+* lifespan イベント
+
+* ハンドラ
+* イベントハンドラ
+* 例外ハンドラ
+* 処理する
+
+* モデル
+* Pydantic モデル
+* データモデル
+* データベースモデル
+* フォームモデル
+* モデルオブジェクト
+
+* クラス
+* 基底クラス
+* 親クラス
+* サブクラス
+* 子クラス
+* 兄弟クラス
+* クラスメソッド
+
+* ヘッダー
+* ヘッダー(複数)
+* 認可ヘッダー
+* `Authorization` ヘッダー
+* Forwarded ヘッダー
+
+* 依存性注入システム
+* 依存関係
+* dependable
+* dependant
+
+* I/O バウンド
+* CPU バウンド
+* 同時実行性
+* 並列性
+* マルチプロセッシング
+
+* env var
+* 環境変数
+* `PATH`
+* `PATH` 環境変数
+
+* 認証
+* 認証プロバイダ
+* 認可
+* 認可フォーム
+* 認可プロバイダ
+* ユーザーが認証する
+* システムがユーザーを認証する
+
+* CLI
+* コマンドラインインターフェース
+
+* サーバー
+* クライアント
+
+* クラウドプロバイダ
+* クラウドサービス
+
+* 開発
+* 開発段階
+
+* dict
+* 辞書
+* 列挙型
+* Enum
+* 列挙メンバー
+
+* エンコーダー
+* デコーダー
+* エンコードする
+* デコードする
+
+* 例外
+* 送出する
+
+* 式
+* 文
+
+* フロントエンド
+* バックエンド
+
+* GitHub ディスカッション
+* GitHub Issue
+
+* パフォーマンス
+* パフォーマンス最適化
+
+* 戻り値の型
+* 戻り値
+
+* セキュリティ
+* セキュリティスキーム
+
+* タスク
+* バックグラウンドタスク
+* タスク関数
+
+* テンプレート
+* テンプレートエンジン
+
+* 型アノテーション
+* 型ヒント
+
+* サーバーワーカー
+* Uvicorn ワーカー
+* Gunicorn ワーカー
+* ワーカープロセス
+* ワーカークラス
+* ワークロード
+
+* デプロイ
+* デプロイする
+
+* SDK
+* ソフトウェア開発キット
+
+* `APIRouter`
+* `requirements.txt`
+* Bearer Token
+* 破壊的変更
+* バグ
+* ボタン
+* 呼び出し可能
+* コード
+* コミット
+* コンテキストマネージャ
+* コルーチン
+* データベースセッション
+* ディスク
+* ドメイン
+* エンジン
+* フェイクの X
+* HTTP GET メソッド
+* アイテム
+* ライブラリ
+* ライフスパン
+* ロック
+* ミドルウェア
+* モバイルアプリケーション
+* モジュール
+* マウント
+* ネットワーク
+* オリジン
+* オーバーライド
+* ペイロード
+* プロセッサ
+* プロパティ
+* プロキシ
+* プルリクエスト
+* クエリ
+* RAM
+* リモートマシン
+* ステータスコード
+* 文字列
+* タグ
+* Web フレームワーク
+* ワイルドカード
+* 返す
+* 検証する
+
+////
+
+//// tab | 情報
+
+これはドキュメントで見られる(主に)技術用語の不完全かつ規範的でない一覧です。プロンプト設計者が、LLM がどの用語で手助けを必要としているかを把握するのに役立つかもしれません。例えば、良い翻訳を最適でない翻訳に戻してしまう場合や、あなたの言語での活用・格変化に問題がある場合などです。
+
+`docs/de/llm-prompt.md` の「### List of English terms and their preferred German translations」の節を参照してください。
+
+////
diff --git a/docs/ja/docs/about/index.md b/docs/ja/docs/about/index.md
new file mode 100644
index 000000000..b099df7fa
--- /dev/null
+++ b/docs/ja/docs/about/index.md
@@ -0,0 +1,3 @@
+# 概要 { #about }
+
+FastAPI の概要、その設計やインスピレーションなどについて解説します。🤓
diff --git a/docs/ja/docs/advanced/additional-responses.md b/docs/ja/docs/advanced/additional-responses.md
new file mode 100644
index 000000000..4c4425788
--- /dev/null
+++ b/docs/ja/docs/advanced/additional-responses.md
@@ -0,0 +1,247 @@
+# OpenAPI の追加レスポンス { #additional-responses-in-openapi }
+
+/// warning | 注意
+
+これは比較的高度なトピックです。
+
+FastAPI を使い始めたばかりであれば、これは不要かもしれません。
+
+///
+
+追加のステータスコード、メディアタイプ、説明などを伴う追加レスポンスを宣言できます。
+
+それらの追加レスポンスは OpenAPI スキーマに含まれ、API ドキュメントにも表示されます。
+
+ただし、それらの追加レスポンスについては、ステータスコードとコンテンツを指定して `JSONResponse` などの `Response` を直接返す必要があります。
+
+## `model` を使った追加レスポンス { #additional-response-with-model }
+
+*path operation デコレータ*に `responses` パラメータを渡せます。
+
+これは `dict` を受け取り、キーは各レスポンスのステータスコード(例: `200`)、値は各レスポンスの情報を含む別の `dict` です。
+
+それぞれのレスポンス `dict` には、`response_model` と同様に Pydantic モデルを格納する `model` キーを含められます。
+
+FastAPI はそのモデルから JSON Schema を生成し、OpenAPI の適切な場所に含めます。
+
+例えば、ステータスコード `404` と Pydantic モデル `Message` を持つ別のレスポンスを宣言するには、次のように書けます:
+
+{* ../../docs_src/additional_responses/tutorial001_py310.py hl[18,22] *}
+
+/// note | 備考
+
+`JSONResponse` を直接返す必要がある点に注意してください。
+
+///
+
+/// info | 情報
+
+`model` キーは OpenAPI の一部ではありません。
+
+FastAPI はそこから Pydantic モデルを取得して JSON Schema を生成し、適切な場所に配置します。
+
+適切な場所は次のとおりです:
+
+- `content` キーの中。これは値として別の JSON オブジェクト(`dict`)を持ち、その中に次が含まれます:
+ - メディアタイプ(例: `application/json`)をキーとし、値としてさらに別の JSON オブジェクトを持ち、その中に次が含まれます:
+ - `schema` キー。値としてモデル由来の JSON Schema を持ち、ここが正しい配置場所です。
+ - FastAPI はここに、スキーマを直接埋め込む代わりに OpenAPI 内のグローバルな JSON Schema への参照を追加します。これにより、他のアプリケーションやクライアントがそれらの JSON Schema を直接利用し、より良いコード生成ツール等を提供できます。
+
+///
+
+この *path operation* のために OpenAPI に生成されるレスポンスは次のとおりです:
+
+```JSON hl_lines="3-12"
+{
+ "responses": {
+ "404": {
+ "description": "Additional Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ },
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Item"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+}
+```
+
+スキーマは OpenAPI スキーマ内の別の場所への参照になります:
+
+```JSON hl_lines="4-16"
+{
+ "components": {
+ "schemas": {
+ "Message": {
+ "title": "Message",
+ "required": [
+ "message"
+ ],
+ "type": "object",
+ "properties": {
+ "message": {
+ "title": "Message",
+ "type": "string"
+ }
+ }
+ },
+ "Item": {
+ "title": "Item",
+ "required": [
+ "id",
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "title": "Id",
+ "type": "string"
+ },
+ "value": {
+ "title": "Value",
+ "type": "string"
+ }
+ }
+ },
+ "ValidationError": {
+ "title": "ValidationError",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "loc": {
+ "title": "Location",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "msg": {
+ "title": "Message",
+ "type": "string"
+ },
+ "type": {
+ "title": "Error Type",
+ "type": "string"
+ }
+ }
+ },
+ "HTTPValidationError": {
+ "title": "HTTPValidationError",
+ "type": "object",
+ "properties": {
+ "detail": {
+ "title": "Detail",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+}
+```
+
+## メインのレスポンスに追加のメディアタイプ { #additional-media-types-for-the-main-response }
+
+同じ `responses` パラメータを使って、同一のメインレスポンスに別のメディアタイプを追加できます。
+
+例えば、`image/png` の追加メディアタイプを加え、あなたの *path operation* が JSON オブジェクト(メディアタイプ `application/json`)または PNG 画像を返せることを宣言できます:
+
+{* ../../docs_src/additional_responses/tutorial002_py310.py hl[17:22,26] *}
+
+/// note | 備考
+
+画像は `FileResponse` を使って直接返す必要がある点に注意してください。
+
+///
+
+/// info | 情報
+
+`responses` パラメータで明示的に別のメディアタイプを指定しない限り、FastAPI はレスポンスがメインのレスポンスクラスと同じメディアタイプ(デフォルトは `application/json`)であるとみなします。
+
+ただし、メディアタイプが `None` のカスタムレスポンスクラスを指定している場合、モデルが関連付けられた追加レスポンスには FastAPI は `application/json` を使用します。
+
+///
+
+## 情報の結合 { #combining-information }
+
+`response_model`、`status_code`、`responses` パラメータなど、複数の場所からのレスポンス情報を組み合わせることもできます。
+
+`response_model` を宣言し、デフォルトのステータスコード `200`(必要なら任意のコード)を使い、その同じレスポンスに対する追加情報を `responses` で OpenAPI スキーマに直接記述できます。
+
+FastAPI は `responses` にある追加情報を保持し、モデルの JSON Schema と結合します。
+
+例えば、Pydantic モデルを用い、独自の `description` を持つステータスコード `404` のレスポンスを宣言できます。
+
+さらに、`response_model` を使うステータスコード `200` のレスポンスに独自の `example` を含めることもできます:
+
+{* ../../docs_src/additional_responses/tutorial003_py310.py hl[20:31] *}
+
+これらはすべて結合されて OpenAPI に含まれ、API ドキュメントに表示されます:
+
+
+
+## 事前定義レスポンスとカスタムの組み合わせ { #combine-predefined-responses-and-custom-ones }
+
+多くの *path operations* に適用できる事前定義のレスポンスを用意しつつ、各 *path operation* ごとに必要なカスタムレスポンスと組み合わせたい場合があります。
+
+そのような場合、Python の `**dict_to_unpack` による `dict` の「アンパック」テクニックを使えます:
+
+```Python
+old_dict = {
+ "old key": "old value",
+ "second old key": "second old value",
+}
+new_dict = {**old_dict, "new key": "new value"}
+```
+
+ここでは、`new_dict` には `old_dict` のすべてのキーと値に加え、新しいキーと値が含まれます:
+
+```Python
+{
+ "old key": "old value",
+ "second old key": "second old value",
+ "new key": "new value",
+}
+```
+
+このテクニックを使うと、*path operations* で事前定義レスポンスを再利用し、さらにカスタムのレスポンスを組み合わせられます。
+
+例えば:
+
+{* ../../docs_src/additional_responses/tutorial004_py310.py hl[11:15,24] *}
+
+## OpenAPI レスポンスの詳細 { #more-information-about-openapi-responses }
+
+レスポンスに正確に何を含められるかは、OpenAPI 仕様の次のセクションを参照してください:
+
+- OpenAPI の Responses Object。ここには `Response Object` が含まれます。
+- OpenAPI の Response Object。`responses` パラメータ内の各レスポンスに、ここで定義されている要素を直接含められます。`description`、`headers`、`content`(ここで異なるメディアタイプや JSON Schema を宣言します)、`links` など。
diff --git a/docs/ja/docs/advanced/additional-status-codes.md b/docs/ja/docs/advanced/additional-status-codes.md
index 14b7e8ba8..fdac52e83 100644
--- a/docs/ja/docs/advanced/additional-status-codes.md
+++ b/docs/ja/docs/advanced/additional-status-codes.md
@@ -16,7 +16,7 @@
{* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *}
-/// warning | 注意
+/// warning
上の例のように `Response` を直接返すと、それはそのまま返されます。
@@ -38,4 +38,4 @@
追加のステータスコードとレスポンスを直接返す場合、それらは OpenAPI スキーマ(API ドキュメント)には含まれません。FastAPI には、事前に何が返されるかを知る方法がないからです。
-しかし、[Additional Responses](additional-responses.md){.internal-link target=_blank} を使ってコード内にドキュメント化できます。
+しかし、[追加のレスポンス](additional-responses.md){.internal-link target=_blank} を使ってコード内にドキュメント化できます。
diff --git a/docs/ja/docs/advanced/advanced-dependencies.md b/docs/ja/docs/advanced/advanced-dependencies.md
new file mode 100644
index 000000000..d38ce548d
--- /dev/null
+++ b/docs/ja/docs/advanced/advanced-dependencies.md
@@ -0,0 +1,163 @@
+# 高度な依存関係 { #advanced-dependencies }
+
+## パラメータ化された依存関係 { #parameterized-dependencies }
+
+これまで見てきた依存関係は、固定の関数またはクラスでした。
+
+しかし、多くの異なる関数やクラスを宣言せずに、その依存関係にパラメータを設定したい場合があります。
+
+たとえば、クエリパラメータ `q` に、ある固定の内容が含まれているかを検査する依存関係が欲しいとします。
+
+ただし、その固定の内容はパラメータ化できるようにしたいです。
+
+## "callable" なインスタンス { #a-callable-instance }
+
+Python には、クラスのインスタンスを "callable" にする方法があります。
+
+クラス自体(これはすでに callable です)ではなく、そのクラスのインスタンスです。
+
+そのためには、`__call__` メソッドを宣言します:
+
+{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[12] *}
+
+この場合、この `__call__` が、**FastAPI** が追加のパラメータやサブ依存関係を確認するために使うものになり、後であなたの *path operation 関数* のパラメータに値を渡すために呼び出されるものになります。
+
+## インスタンスのパラメータ化 { #parameterize-the-instance }
+
+そして、`__init__` を使って、依存関係を「パラメータ化」するために利用できるインスタンスのパラメータを宣言できます:
+
+{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[9] *}
+
+この場合、**FastAPI** は `__init__` に触れたり気にかけたりすることはありません。私たちがコード内で直接使います。
+
+## インスタンスの作成 { #create-an-instance }
+
+このクラスのインスタンスは次のように作成できます:
+
+{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[18] *}
+
+このようにして依存関係を「パラメータ化」できます。いまや `"bar"` が属性 `checker.fixed_content` として中に保持されています。
+
+## インスタンスを依存関係として使う { #use-the-instance-as-a-dependency }
+
+その後、`Depends(FixedContentQueryChecker)` の代わりに `Depends(checker)` でこの `checker` を使えます。依存関係はクラスそのものではなく、インスタンスである `checker` だからです。
+
+依存関係を解決するとき、**FastAPI** はこの `checker` を次のように呼び出します:
+
+```Python
+checker(q="somequery")
+```
+
+...そして、その戻り値を *path operation 関数* 内の依存関係の値として、パラメータ `fixed_content_included` に渡します:
+
+{* ../../docs_src/dependencies/tutorial011_an_py310.py hl[22] *}
+
+/// tip | 豆知識
+
+ここまでの内容は回りくどく感じられるかもしれません。まだどのように役立つかが明確でないかもしれません。
+
+これらの例は意図的に単純ですが、仕組みを示しています。
+
+セキュリティの章では、同じやり方で実装されたユーティリティ関数があります。
+
+ここまでを理解できていれば、そうしたセキュリティ用ユーティリティが内部でどのように動いているかも理解できています。
+
+///
+
+## `yield`、`HTTPException`、`except` とバックグラウンドタスクを伴う依存関係 { #dependencies-with-yield-httpexception-except-and-background-tasks }
+
+/// warning | 注意
+
+これらの技術的詳細は、ほとんどの場合は不要です。
+
+主に、0.121.0 より前の FastAPI アプリケーションがあり、`yield` を使う依存関係で問題が発生している場合に有用です。
+
+///
+
+`yield` を使う依存関係は、さまざまなユースケースに対応し、いくつかの問題を修正するために時間とともに進化してきました。ここでは変更点の概要を説明します。
+
+### `yield` と `scope` を伴う依存関係 { #dependencies-with-yield-and-scope }
+
+バージョン 0.121.0 で、`yield` を使う依存関係に対して `Depends(scope="function")` がサポートされました。
+
+`Depends(scope="function")` を使うと、`yield` の後の終了コードは、クライアントへレスポンスが返される前、*path operation 関数* が終了した直後に実行されます。
+
+そして、`Depends(scope="request")`(デフォルト)を使う場合、`yield` の後の終了コードはレスポンス送信後に実行されます。
+
+詳しくはドキュメント「[`yield` を使う依存関係 - 早期終了と `scope`](../tutorial/dependencies/dependencies-with-yield.md#early-exit-and-scope)」を参照してください。
+
+### `yield` と `StreamingResponse` を伴う依存関係、技術詳細 { #dependencies-with-yield-and-streamingresponse-technical-details }
+
+FastAPI 0.118.0 より前では、`yield` を使う依存関係を使用すると、*path operation 関数* が戻ってからレスポンス送信直前に終了コードが実行されていました。
+
+これは、レスポンスがネットワーク上を移動するのを待っている間に、不要にリソースを保持しないようにする意図でした。
+
+この変更により、`StreamingResponse` を返す場合、`yield` を持つ依存関係の終了コードはすでに実行されていることになりました。
+
+たとえば、`yield` を持つ依存関係の中でデータベースセッションを持っていた場合、`StreamingResponse` はデータをストリーミングしている間にそのセッションを使えません。というのも、`yield` の後の終了コードでそのセッションがすでにクローズされているからです。
+
+この挙動は 0.118.0 で元に戻され、`yield` の後の終了コードはレスポンス送信後に実行されるようになりました。
+
+/// info | 情報
+
+以下で見るように、これはバージョン 0.106.0 より前の挙動ととても似ていますが、いくつかのコーナーケースに対する改良とバグ修正が含まれています。
+
+///
+
+#### 早期終了コードのユースケース { #use-cases-with-early-exit-code }
+
+特定の条件では、レスポンス送信前に `yield` を持つ依存関係の終了コードを実行する、古い挙動の恩恵を受けられるユースケースがあります。
+
+例えば、`yield` を持つ依存関係でデータベースセッションを使ってユーザ検証だけを行い、その後は *path operation 関数* 内ではそのデータベースセッションを一切使わない、かつレスポンス送信に長い時間がかかる(例えばデータをゆっくり送る `StreamingResponse`)が、何らかの理由でデータベースは使わない、というケースです。
+
+この場合、レスポンスの送信が終わるまでデータベースセッションが保持されますが、使わないのであれば保持する必要はありません。
+
+次のようになります:
+
+{* ../../docs_src/dependencies/tutorial013_an_py310.py *}
+
+終了コード、すなわち `Session` の自動クローズは:
+
+{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[19:21] *}
+
+...の部分で定義されており、遅いデータ送信が終わった後に実行されます:
+
+{* ../../docs_src/dependencies/tutorial013_an_py310.py ln[30:38] hl[31:33] *}
+
+しかし、`generate_stream()` はデータベースセッションを使わないため、レスポンス送信中にセッションを開いたままにしておく必要は実際にはありません。
+
+SQLModel(または SQLAlchemy)でこの特定のユースケースがある場合は、不要になった時点でセッションを明示的にクローズできます:
+
+{* ../../docs_src/dependencies/tutorial014_an_py310.py ln[24:28] hl[28] *}
+
+このようにすると、セッションはデータベース接続を解放するため、他のリクエストがそれを使えるようになります。
+
+`yield` を持つ依存関係で早期終了が必要な別のユースケースがある場合は、あなたの具体的なユースケースと、なぜ `yield` を持つ依存関係の早期クローズが有益かを説明して、GitHub Discussion の質問を作成してください。
+
+`yield` を持つ依存関係の早期クローズに納得できるユースケースがある場合は、早期クローズにオプトインする新しい方法を追加することを検討します。
+
+### `yield` と `except` を伴う依存関係、技術詳細 { #dependencies-with-yield-and-except-technical-details }
+
+FastAPI 0.110.0 より前では、`yield` を持つ依存関係を使い、その依存関係内で `except` によって例外を捕捉し、再度その例外を送出しなかった場合でも、その例外は自動的に送出(フォワード)され、任意の例外ハンドラまたは内部サーバエラーハンドラに渡されていました。
+
+これは、ハンドラのないフォワードされた例外(内部サーバエラー)による未処理のメモリ消費を修正し、通常の Python コードの挙動と一貫性を持たせるため、バージョン 0.110.0 で変更されました。
+
+### バックグラウンドタスクと `yield` を伴う依存関係、技術詳細 { #background-tasks-and-dependencies-with-yield-technical-details }
+
+FastAPI 0.106.0 より前では、`yield` の後で例外を送出することはできませんでした。`yield` を持つ依存関係の終了コードはレスポンス送信「後」に実行されるため、[例外ハンドラ](../tutorial/handling-errors.md#install-custom-exception-handlers){.internal-link target=_blank} はすでに実行済みでした。
+
+これは主に、依存関係が "yield" した同じオブジェクトをバックグラウンドタスク内で利用できるようにするための設計でした。終了コードはバックグラウンドタスク完了後に実行されるからです。
+
+これは、レスポンスがネットワーク上を移動するのを待っている間にリソースを保持しないようにする意図で、FastAPI 0.106.0 で変更されました。
+
+/// tip | 豆知識
+
+加えて、バックグラウンドタスクは通常、独立したロジックの集合であり、(例えば専用のデータベース接続など)それ自身のリソースで個別に扱うべきです。
+
+そのため、このやり方の方がコードはおそらくよりクリーンになります。
+
+///
+
+この挙動に依存していた場合は、バックグラウンドタスク用のリソースをバックグラウンドタスク内部で作成し、`yield` を持つ依存関係のリソースに依存しないデータだけを内部で使用するようにしてください。
+
+例えば、同じデータベースセッションを使うのではなく、バックグラウンドタスク内で新しいデータベースセッションを作成し、この新しいセッションでデータベースからオブジェクトを取得します。そして、バックグラウンドタスク関数の引数としてデータベースのオブジェクト自体を渡すのではなく、そのオブジェクトの ID を渡し、バックグラウンドタスク関数内でもう一度そのオブジェクトを取得します。
diff --git a/docs/ja/docs/advanced/advanced-python-types.md b/docs/ja/docs/advanced/advanced-python-types.md
new file mode 100644
index 000000000..b4409bcf6
--- /dev/null
+++ b/docs/ja/docs/advanced/advanced-python-types.md
@@ -0,0 +1,61 @@
+# 高度な Python の型 { #advanced-python-types }
+
+Python の型を扱うときに役立つ追加のアイデアをいくつか紹介します。
+
+## `Union` または `Optional` の利用 { #using-union-or-optional }
+
+何らかの理由で `|` が使えない場合、たとえば型アノテーションではなく `response_model=` のような場所では、縦棒(`|`)の代わりに `typing` の `Union` を使えます。
+
+例えば、`str` または `None` になり得ることを宣言できます:
+
+```python
+from typing import Union
+
+
+def say_hi(name: Union[str, None]):
+ print(f"Hi {name}!")
+```
+
+`typing` には、`None` を取り得ることを宣言するための短縮形として `Optional` もあります。
+
+ここからは私のとても主観的な提案です:
+
+- 🚨 `Optional[SomeType]` の使用は避けましょう
+- 代わりに ✨ **`Union[SomeType, None]` を使いましょう** ✨。
+
+どちらも等価で内部的には同一ですが、「optional(任意)」という語が値が任意だと誤解させやすく、実際の意味は「`None` を取り得る」であり、任意ではなく依然として必須である場合でもそうです。そのため `Optional` より `Union` を勧めます。
+
+`Union[SomeType, None]` の方が意味がより明確だと思います。
+
+これは用語や名前付けの話に過ぎませんが、その言葉があなたやチームメイトのコードの捉え方に影響します。
+
+例として次の関数を見てみましょう:
+
+```python
+from typing import Optional
+
+
+def say_hi(name: Optional[str]):
+ print(f"Hey {name}!")
+```
+
+パラメータ `name` は `Optional[str]` と定義されていますが、任意ではありません。このパラメータなしで関数を呼び出すことはできません:
+
+```Python
+say_hi() # あっ、これはエラーになります!😱
+```
+
+`name` パラメータにはデフォルト値がないため、依然として必須(任意ではない)です。ただし、`name` は値として `None` を受け付けます:
+
+```Python
+say_hi(name=None) # これは動作します。None は有効です 🎉
+```
+
+朗報として、多くの場合は単純に `|` を使って型の Union を定義できます:
+
+```python
+def say_hi(name: str | None):
+ print(f"Hey {name}!")
+```
+
+したがって、通常は `Optional` や `Union` といった名前を気にする必要はありません。😎
diff --git a/docs/ja/docs/advanced/async-tests.md b/docs/ja/docs/advanced/async-tests.md
new file mode 100644
index 000000000..067e9cc9a
--- /dev/null
+++ b/docs/ja/docs/advanced/async-tests.md
@@ -0,0 +1,99 @@
+# 非同期テスト { #async-tests }
+
+これまでに、提供されている `TestClient` を使って **FastAPI** アプリケーションをテストする方法を見てきました。ここまでは、`async` 関数を使わない同期テストのみでした。
+
+テストで非同期関数を使えると、たとえばデータベースへ非同期にクエリする場合などに便利です。非同期データベースライブラリを使いながら、FastAPI アプリにリクエストを送り、その後バックエンドが正しいデータをデータベースに書き込めたかを検証したい、といったケースを想像してください。
+
+その方法を見ていきます。
+
+## pytest.mark.anyio { #pytest-mark-anyio }
+
+テスト内で非同期関数を呼び出したい場合、テスト関数自体も非同期である必要があります。AnyIO はこれを実現するための便利なプラグインを提供しており、特定のテスト関数を非同期で呼び出すことを指定できます。
+
+## HTTPX { #httpx }
+
+**FastAPI** アプリケーションが通常の `def` 関数を使っていても、その内側は依然として `async` アプリケーションです。
+
+`TestClient` は、標準の pytest を使って通常の `def` のテスト関数から非同期の FastAPI アプリを呼び出すための「おまじない」を内部で行います。しかし、その「おまじない」はテスト関数自体が非同期の場合には機能しません。テストを非同期で実行すると、テスト関数内で `TestClient` は使えなくなります。
+
+`TestClient` は HTTPX を基に作られており、幸いなことに API のテストには HTTPX を直接利用できます。
+
+## 例 { #example }
+
+簡単な例として、[大きなアプリケーション](../tutorial/bigger-applications.md){.internal-link target=_blank} と [テスト](../tutorial/testing.md){.internal-link target=_blank} で説明したものに似たファイル構成を考えます:
+
+```
+.
+├── app
+│ ├── __init__.py
+│ ├── main.py
+│ └── test_main.py
+```
+
+`main.py` は次のようになります:
+
+{* ../../docs_src/async_tests/app_a_py310/main.py *}
+
+`test_main.py` は `main.py` のテストを持ち、次のようになります:
+
+{* ../../docs_src/async_tests/app_a_py310/test_main.py *}
+
+## 実行 { #run-it }
+
+テストはいつも通り次で実行できます:
+
+
+
+しかし、プロキシ(ポート `9999`)を使った「公式」URL `/api/v1/docs` でドキュメント UI にアクセスすると、正しく動作します!🎉
+
+http://127.0.0.1:9999/api/v1/docs を確認してください:
+
+
+
+ねらいどおりです。✔️
+
+これは、FastAPI が `root_path` を使って、OpenAPI の既定の `server` を `root_path` の URL で生成するためです。
+
+## 追加のサーバー { #additional-servers }
+
+/// warning | 注意
+
+これは高度なユースケースです。読み飛ばしても構いません。
+
+///
+
+既定では、**FastAPI** は OpenAPI スキーマ内に `root_path` の URL を持つ `server` を作成します。
+
+しかし、ステージングと本番の両方と同じドキュメント UI で対話させたい場合など、別の `servers` を指定することもできます。
+
+カスタムの `servers` リストを渡していて、かつ `root_path`(API がプロキシの背後にあるため)が設定されている場合、**FastAPI** はこの `root_path` を用いた「server」をリストの先頭に挿入します。
+
+例えば:
+
+{* ../../docs_src/behind_a_proxy/tutorial003_py310.py hl[4:7] *}
+
+次のような OpenAPI スキーマが生成されます:
+
+```JSON hl_lines="5-7"
+{
+ "openapi": "3.1.0",
+ // ほかの項目
+ "servers": [
+ {
+ "url": "/api/v1"
+ },
+ {
+ "url": "https://stag.example.com",
+ "description": "Staging environment"
+ },
+ {
+ "url": "https://prod.example.com",
+ "description": "Production environment"
+ }
+ ],
+ "paths": {
+ // ほかの項目
+ }
+}
+```
+
+/// tip | 豆知識
+
+`root_path` から取得した `url` 値 `/api/v1` を持つ server が自動生成されている点に注目してください。
+
+///
+
+ドキュメント UI(http://127.0.0.1:9999/api/v1/docs)では次のように表示されます:
+
+
+
+/// tip | 豆知識
+
+ドキュメント UI は、選択した server と対話します。
+
+///
+
+/// note | 技術詳細
+
+OpenAPI 仕様の `servers` プロパティは任意です。
+
+`servers` パラメータを指定せず、かつ `root_path` が `/` の場合、生成される OpenAPI スキーマからは `servers` プロパティが既定で完全に省略されます。これは、`url` が `/` の server が 1 つあるのと同等です。
+
+///
+
+### `root_path` 由来の自動 server を無効化 { #disable-automatic-server-from-root-path }
+
+`root_path` を用いた自動的な server を **FastAPI** に含めてほしくない場合は、パラメータ `root_path_in_servers=False` を使用します:
+
+{* ../../docs_src/behind_a_proxy/tutorial004_py310.py hl[9] *}
+
+すると、OpenAPI スキーマには含まれません。
+
+## サブアプリケーションのマウント { #mounting-a-sub-application }
+
+`root_path` を伴うプロキシを使用しつつサブアプリケーションをマウントする必要がある場合でも([サブアプリケーション - マウント](sub-applications.md){.internal-link target=_blank} 参照)、通常どおりに行えます。
+
+FastAPI は内部で `root_path` を適切に扱うため、そのまま動作します。✨
diff --git a/docs/ja/docs/advanced/custom-response.md b/docs/ja/docs/advanced/custom-response.md
index 9d881c013..50a789165 100644
--- a/docs/ja/docs/advanced/custom-response.md
+++ b/docs/ja/docs/advanced/custom-response.md
@@ -30,7 +30,7 @@
しかし、返そうとしているコンテンツが **JSONでシリアライズ可能**であることが確実なら、それを直接レスポンスクラスに渡して、FastAPIがレスポンスクラスへ渡す前に返却コンテンツを `jsonable_encoder` に通すことで発生する追加のオーバーヘッドを回避できます。
-{* ../../docs_src/custom_response/tutorial001b_py39.py hl[2,7] *}
+{* ../../docs_src/custom_response/tutorial001b_py310.py hl[2,7] *}
/// info | 情報
@@ -55,7 +55,7 @@
* `HTMLResponse` をインポートする。
* *path operation デコレータ* のパラメータ `response_class` に `HTMLResponse` を渡す。
-{* ../../docs_src/custom_response/tutorial002_py39.py hl[2,7] *}
+{* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *}
/// info | 情報
@@ -73,7 +73,7 @@
上記と同じ例において、 `HTMLResponse` を返すと、このようになります:
-{* ../../docs_src/custom_response/tutorial003_py39.py hl[2,7,19] *}
+{* ../../docs_src/custom_response/tutorial003_py310.py hl[2,7,19] *}
/// warning | 注意
@@ -97,7 +97,7 @@
例えば、このようになります:
-{* ../../docs_src/custom_response/tutorial004_py39.py hl[7,21,23] *}
+{* ../../docs_src/custom_response/tutorial004_py310.py hl[7,21,23] *}
この例では、関数 `generate_html_response()` は、`str` のHTMLを返すのではなく、`Response` を生成して返しています。
@@ -136,7 +136,7 @@
FastAPI(実際にはStarlette)は自動的にContent-Lengthヘッダーを含みます。また、`media_type` に基づいたContent-Typeヘッダーを含み、テキストタイプのためにcharsetを追加します。
-{* ../../docs_src/response_directly/tutorial002_py39.py hl[1,18] *}
+{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *}
### `HTMLResponse` { #htmlresponse }
@@ -146,7 +146,7 @@ FastAPI(実際にはStarlette)は自動的にContent-Lengthヘッダーを
テキストやバイトを受け取り、プレーンテキストのレスポンスを返します。
-{* ../../docs_src/custom_response/tutorial005_py39.py hl[2,7,9] *}
+{* ../../docs_src/custom_response/tutorial005_py310.py hl[2,7,9] *}
### `JSONResponse` { #jsonresponse }
@@ -180,7 +180,7 @@ FastAPI(実際にはStarlette)は自動的にContent-Lengthヘッダーを
///
-{* ../../docs_src/custom_response/tutorial001_py39.py hl[2,7] *}
+{* ../../docs_src/custom_response/tutorial001_py310.py hl[2,7] *}
/// tip | 豆知識
@@ -194,13 +194,13 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
`RedirectResponse` を直接返せます:
-{* ../../docs_src/custom_response/tutorial006_py39.py hl[2,9] *}
+{* ../../docs_src/custom_response/tutorial006_py310.py hl[2,9] *}
---
または、`response_class` パラメータで使用できます:
-{* ../../docs_src/custom_response/tutorial006b_py39.py hl[2,7,9] *}
+{* ../../docs_src/custom_response/tutorial006b_py310.py hl[2,7,9] *}
その場合、*path operation*関数からURLを直接返せます。
@@ -210,13 +210,13 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
また、`status_code` パラメータを `response_class` パラメータと組み合わせて使うこともできます:
-{* ../../docs_src/custom_response/tutorial006c_py39.py hl[2,7,9] *}
+{* ../../docs_src/custom_response/tutorial006c_py310.py hl[2,7,9] *}
### `StreamingResponse` { #streamingresponse }
非同期ジェネレータ、または通常のジェネレータ/イテレータを受け取り、レスポンスボディをストリームします。
-{* ../../docs_src/custom_response/tutorial007_py39.py hl[2,14] *}
+{* ../../docs_src/custom_response/tutorial007_py310.py hl[2,14] *}
#### ファイルライクオブジェクトで `StreamingResponse` を使う { #using-streamingresponse-with-file-like-objects }
@@ -226,7 +226,7 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
これにはクラウドストレージとの連携、映像処理など、多くのライブラリが含まれます。
-{* ../../docs_src/custom_response/tutorial008_py39.py hl[2,10:12,14] *}
+{* ../../docs_src/custom_response/tutorial008_py310.py hl[2,10:12,14] *}
1. これはジェネレータ関数です。内部に `yield` 文を含むため「ジェネレータ関数」です。
2. `with` ブロックを使うことで、ジェネレータ関数が終わった後(つまりレスポンスの送信が完了した後)にfile-likeオブジェクトが確実にクローズされるようにします。
@@ -255,11 +255,11 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
ファイルレスポンスには、適切な `Content-Length`、`Last-Modified`、`ETag` ヘッダーが含まれます。
-{* ../../docs_src/custom_response/tutorial009_py39.py hl[2,10] *}
+{* ../../docs_src/custom_response/tutorial009_py310.py hl[2,10] *}
`response_class` パラメータを使うこともできます:
-{* ../../docs_src/custom_response/tutorial009b_py39.py hl[2,8,10] *}
+{* ../../docs_src/custom_response/tutorial009b_py310.py hl[2,8,10] *}
この場合、*path operation*関数からファイルパスを直接返せます。
@@ -273,7 +273,7 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
`CustomORJSONResponse` を作れます。主に必要なのは、コンテンツを `bytes` として返す `Response.render(content)` メソッドを作ることです:
-{* ../../docs_src/custom_response/tutorial009c_py39.py hl[9:14,17] *}
+{* ../../docs_src/custom_response/tutorial009c_py310.py hl[9:14,17] *}
これまでは次のように返していたものが:
@@ -299,7 +299,7 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス
以下の例では、**FastAPI** はすべての*path operation*で、`JSONResponse` の代わりに `ORJSONResponse` をデフォルトとして使います。
-{* ../../docs_src/custom_response/tutorial010_py39.py hl[2,4] *}
+{* ../../docs_src/custom_response/tutorial010_py310.py hl[2,4] *}
/// tip | 豆知識
diff --git a/docs/ja/docs/advanced/dataclasses.md b/docs/ja/docs/advanced/dataclasses.md
new file mode 100644
index 000000000..74f479f07
--- /dev/null
+++ b/docs/ja/docs/advanced/dataclasses.md
@@ -0,0 +1,95 @@
+# Dataclasses の使用 { #using-dataclasses }
+
+FastAPI は **Pydantic** の上に構築されており、これまでにリクエストやレスポンスを宣言するために Pydantic モデルを使う方法を紹介してきました。
+
+しかし FastAPI は、同様の方法で `dataclasses` もサポートします:
+
+{* ../../docs_src/dataclasses_/tutorial001_py310.py hl[1,6:11,18:19] *}
+
+これは **Pydantic** によって引き続きサポートされています。Pydantic には `dataclasses` の内部サポート があるためです。
+
+そのため、上記のように明示的に Pydantic を使っていないコードでも、FastAPI は標準の dataclass を Pydantic 独自の dataclass に変換するために Pydantic を使用しています。
+
+そして当然ながら、次の点も同様にサポートされます:
+
+- データ検証
+- データのシリアライズ
+- データのドキュメント化 など
+
+これは Pydantic モデルの場合と同じように動作します。内部的にも同様に Pydantic を使って実現されています。
+
+/// info | 情報
+
+dataclasses は、Pydantic モデルができることをすべては行えない点に留意してください。
+
+そのため、Pydantic モデルを使う必要がある場合もあります。
+
+しかし既存の dataclass が多数あるなら、FastAPI で Web API を構築する際にそれらを活用するちょっとしたテクニックになります。🤓
+
+///
+
+## `response_model` での dataclasses { #dataclasses-in-response-model }
+
+`response_model` パラメータでも `dataclasses` を使用できます:
+
+{* ../../docs_src/dataclasses_/tutorial002_py310.py hl[1,6:12,18] *}
+
+dataclass は自動的に Pydantic の dataclass に変換されます。
+
+このため、そのスキーマは API ドキュメントの UI に表示されます:
+
+
+
+## ネストしたデータ構造での dataclasses { #dataclasses-in-nested-data-structures }
+
+`dataclasses` を他の型注釈と組み合わせて、ネストしたデータ構造を作成できます。
+
+場合によっては、自動生成された API ドキュメントでエラーが発生するなどの理由で、Pydantic 版の `dataclasses` を使う必要があるかもしれません。
+
+その場合は、標準の `dataclasses` を `pydantic.dataclasses` に置き換えるだけで済みます。これはドロップイン置換です:
+
+{* ../../docs_src/dataclasses_/tutorial003_py310.py hl[1,4,7:10,13:16,22:24,27] *}
+
+1. 依然として標準の `dataclasses` から `field` をインポートします。
+
+2. `pydantic.dataclasses` は `dataclasses` のドロップイン置換です。
+
+3. `Author` dataclass は `Item` dataclass のリストを含みます。
+
+4. `Author` dataclass を `response_model` パラメータとして使用しています。
+
+5. リクエストボディとしての dataclass と併せて、他の標準の型注釈を使用できます。
+
+ この例では、`Item` dataclass のリストです。
+
+6. ここでは、dataclass のリストである `items` を含む辞書を返しています。
+
+ FastAPI はデータを JSON に シリアライズ できます。
+
+7. ここでは `response_model` に `Author` dataclass のリストという型注釈を使用しています。
+
+ このように、`dataclasses` は標準の型注釈と組み合わせられます。
+
+8. この *path operation 関数* は、`async def` ではなく通常の `def` を使用しています。
+
+ いつもどおり、FastAPI では必要に応じて `def` と `async def` を組み合わせられます。
+
+ どちらをいつ使うかの復習が必要な場合は、[`async` と `await`](../async.md#in-a-hurry){.internal-link target=_blank} に関するドキュメントの _"In a hurry?"_ セクションを参照してください。
+
+9. この *path operation 関数* は(可能ではありますが)dataclass 自体は返さず、内部データを持つ辞書のリストを返しています。
+
+ FastAPI は dataclass を含む `response_model` パラメータを使ってレスポンスを変換します。
+
+`dataclasses` は他の型注釈と多様な組み合わせが可能で、複雑なデータ構造を構成できます。
+
+上記のコード内コメントのヒントを参照して、より具体的な詳細を確認してください。
+
+## さらに学ぶ { #learn-more }
+
+`dataclasses` を他の Pydantic モデルと組み合わせたり、継承したり、自分のモデルに含めたりもできます。
+
+詳しくは、dataclasses に関する Pydantic ドキュメント を参照してください。
+
+## バージョン { #version }
+
+これは FastAPI バージョン `0.67.0` 以降で利用可能です。🔖
diff --git a/docs/ja/docs/advanced/events.md b/docs/ja/docs/advanced/events.md
new file mode 100644
index 000000000..fb79062fa
--- /dev/null
+++ b/docs/ja/docs/advanced/events.md
@@ -0,0 +1,165 @@
+# Lifespan イベント { #lifespan-events }
+
+アプリケーションが起動する前に一度だけ実行すべきロジック(コード)を定義できます。これは、アプリケーションがリクエストを受け取り始める前に、そのコードが一度だけ実行される、という意味です。
+
+同様に、アプリケーションがシャットダウンするときに実行すべきロジック(コード)も定義できます。この場合、そのコードは、(多くのリクエストを処理した)後に一度だけ実行されます。
+
+このコードは、アプリケーションがリクエストの受け付けを「開始」する前、そして処理を「終了」した直後に実行されるため、アプリケーションの全体の「Lifespan」(この「lifespan」という言葉はすぐ後で重要になります 😉)をカバーします。
+
+これは、アプリ全体で使用し、リクエスト間で「共有」し、かつ後で「クリーンアップ」する必要があるような「リソース」をセットアップするのにとても便利です。たとえば、データベース接続プールや、共有の機械学習モデルの読み込みなどです。
+
+## ユースケース { #use-case }
+
+まずはユースケースの例から始めて、これをどのように解決するかを見ていきます。
+
+リクエストを処理するために使用したい「機械学習モデル」がいくつかあると想像してください。🤖
+
+同じモデルをリクエスト間で共有するので、リクエストごとやユーザーごとに別々のモデルを使うわけではありません。
+
+モデルの読み込みにはディスクから大量のデータを読む必要があり、かなり時間がかかるかもしれません。したがって、リクエストごとに読み込みたくはありません。
+
+モジュール/ファイルのトップレベルで読み込むこともできますが、その場合は、たとえ簡単な自動テストを実行するだけでも「モデルを読み込む」ことになり、そのモデルの読み込みを待つ必要があるため、独立したコード部分を走らせるだけのテストでも「遅く」なってしまいます。
+
+これを解決しましょう。リクエストを処理する前にモデルを読み込みますが、コードがロードされている最中ではなく、アプリケーションがリクエストの受け付けを開始する直前だけにします。
+
+## Lifespan { #lifespan }
+
+この「起動時」と「シャットダウン時」のロジックは、`FastAPI` アプリの `lifespan` パラメータと「コンテキストマネージャ」(これが何かはすぐに示します)を使って定義できます。
+
+まずは例を見てから、詳細を説明します。
+
+次のように、`yield` を使う非同期関数 `lifespan()` を作成します:
+
+{* ../../docs_src/events/tutorial003_py310.py hl[16,19] *}
+
+ここでは、`yield` の前で機械学習モデルの辞書に(ダミーの)モデル関数を入れることで、高コストな「起動時」のモデル読み込みをシミュレーションしています。このコードは、アプリケーションがリクエストを「受け付け始める前」に、すなわち起動時に実行されます。
+
+そして `yield` の直後でモデルをアンロードします。このコードは、アプリケーションがリクエスト処理を「終了」した後、シャットダウン直前に実行されます。たとえばメモリや GPU のようなリソースを解放できます。
+
+/// tip | 豆知識
+
+`shutdown` は、アプリケーションを「停止」するときに発生します。
+
+新しいバージョンを開始する必要があるか、単に実行をやめたくなったのかもしれません。🤷
+
+///
+
+### Lifespan 関数 { #lifespan-function }
+
+まず注目すべきは、`yield` を使う非同期関数を定義していることです。これは「yield を使う依存関係(Dependencies)」にとてもよく似ています。
+
+{* ../../docs_src/events/tutorial003_py310.py hl[14:19] *}
+
+`yield` の前の前半は、アプリケーションが開始される「前」に実行されます。
+
+`yield` の後半は、アプリケーションの処理が「終了」した「後」に実行されます。
+
+### 非同期コンテキストマネージャ { #async-context-manager }
+
+この関数には `@asynccontextmanager` がデコレートされています。
+
+これにより、この関数は「非同期コンテキストマネージャ」になります。
+
+{* ../../docs_src/events/tutorial003_py310.py hl[1,13] *}
+
+Python の「コンテキストマネージャ」は、`with` 文で使えるものです。たとえば、`open()` はコンテキストマネージャとして使えます:
+
+```Python
+with open("file.txt") as file:
+ file.read()
+```
+
+最近の Python には「非同期コンテキストマネージャ」もあります。`async with` で使います:
+
+```Python
+async with lifespan(app):
+ await do_stuff()
+```
+
+このようにコンテキストマネージャ(または非同期コンテキストマネージャ)を作ると、`with` ブロックに入る前に `yield` より前のコードが実行され、`with` ブロックを出た後に `yield` より後ろのコードが実行されます。
+
+上のコード例では直接それを使ってはいませんが、FastAPI に渡して内部で使ってもらいます。
+
+`FastAPI` アプリの `lifespan` パラメータは「非同期コンテキストマネージャ」を受け取るので、新しく作った `lifespan` 非同期コンテキストマネージャを渡せます。
+
+{* ../../docs_src/events/tutorial003_py310.py hl[22] *}
+
+## 代替のイベント(非推奨) { #alternative-events-deprecated }
+
+/// warning | 注意
+
+推奨される方法は、上で説明したとおり `FastAPI` アプリの `lifespan` パラメータを使って「起動」と「シャットダウン」を扱うことです。`lifespan` パラメータを指定すると、`startup` と `shutdown` のイベントハンドラは呼び出されなくなります。`lifespan` かイベントか、どちらか一方であり、両方同時ではありません。
+
+この節は読み飛ばしてもかまいません。
+
+///
+
+起動時とシャットダウン時に実行されるロジックを定義する別の方法もあります。
+
+アプリケーションが起動する前、またはシャットダウンするときに実行する必要があるイベントハンドラ(関数)を定義できます。
+
+これらの関数は `async def` でも、通常の `def` でも構いません。
+
+### `startup` イベント { #startup-event }
+
+アプリケーションが開始される前に実行すべき関数を追加するには、イベント `"startup"` で宣言します:
+
+{* ../../docs_src/events/tutorial001_py310.py hl[8] *}
+
+この場合、`startup` のイベントハンドラ関数は items の「データベース」(単なる `dict`)をいくつかの値で初期化します。
+
+イベントハンドラ関数は複数追加できます。
+
+すべての `startup` イベントハンドラが完了するまで、アプリケーションはリクエストの受け付けを開始しません。
+
+### `shutdown` イベント { #shutdown-event }
+
+アプリケーションがシャットダウンするときに実行すべき関数を追加するには、イベント `"shutdown"` で宣言します:
+
+{* ../../docs_src/events/tutorial002_py310.py hl[6] *}
+
+ここでは、`shutdown` のイベントハンドラ関数が、テキスト行 `"Application shutdown"` をファイル `log.txt` に書き込みます。
+
+/// info | 情報
+
+`open()` 関数の `mode="a"` は「追加」(append)を意味します。つまり、そのファイルに既にある内容を上書きせず、行が後ろに追記されます。
+
+///
+
+/// tip | 豆知識
+
+この例では、ファイルを扱う標準の Python 関数 `open()` を使っています。
+
+そのため、ディスクへの書き込みを「待つ」必要がある I/O(入力/出力)が関わります。
+
+しかし `open()` 自体は `async` や `await` を使いません。
+
+したがって、イベントハンドラ関数は `async def` ではなく通常の `def` で宣言しています。
+
+///
+
+### `startup` と `shutdown` をまとめて { #startup-and-shutdown-together }
+
+起動時とシャットダウン時のロジックは関連していることが多いです。何かを開始してから終了したい、リソースを獲得してから解放したい、などです.
+
+共有するロジックや変数のない別々の関数でそれを行うのは難しく、グローバル変数などに値を保存する必要が出てきます。
+
+そのため、現在は上で説明したとおり `lifespan` を使うことが推奨されています。
+
+## 技術詳細 { #technical-details }
+
+技術が気になる方への細かな詳細です。🤓
+
+内部的には、ASGI の技術仕様において、これは Lifespan プロトコル の一部であり、`startup` と `shutdown` というイベントが定義されています。
+
+/// info | 情報
+
+Starlette の `lifespan` ハンドラについては、Starlette の Lifespan ドキュメントで詳しく読むことができます。
+
+コードの他の領域で使える lifespan の状態をどのように扱うかも含まれています。
+
+///
+
+## サブアプリケーション { #sub-applications }
+
+🚨 これらの lifespan イベント(startup と shutdown)はメインのアプリケーションに対してのみ実行され、[サブアプリケーション - マウント](sub-applications.md){.internal-link target=_blank} には実行されないことに注意してください。
diff --git a/docs/ja/docs/advanced/generate-clients.md b/docs/ja/docs/advanced/generate-clients.md
new file mode 100644
index 000000000..7b9f82054
--- /dev/null
+++ b/docs/ja/docs/advanced/generate-clients.md
@@ -0,0 +1,208 @@
+# SDK の生成 { #generating-sdks }
+
+**FastAPI** は **OpenAPI** 仕様に基づいているため、その API は多くのツールが理解できる標準形式で記述できます。
+
+これにより、最新の**ドキュメント**、複数言語のクライアントライブラリ(**SDKs**)、そしてコードと同期し続ける**テスト**や**自動化ワークフロー**を容易に生成できます。
+
+本ガイドでは、FastAPI バックエンド向けの **TypeScript SDK** を生成する方法を説明します。
+
+## オープソースの SDK ジェネレータ { #open-source-sdk-generators }
+
+多用途な選択肢として OpenAPI Generator があります。これは**多数のプログラミング言語**をサポートし、OpenAPI 仕様から SDK を生成できます。
+
+**TypeScript クライアント**向けには、Hey API が目的特化のソリューションで、TypeScript エコシステムに最適化された体験を提供します。
+
+他の SDK ジェネレータは OpenAPI.Tools でも見つけられます。
+
+/// tip | 豆知識
+
+FastAPI は自動的に **OpenAPI 3.1** の仕様を生成します。したがって、使用するツールはこのバージョンをサポートしている必要があります。
+
+///
+
+## FastAPI スポンサーによる SDK ジェネレータ { #sdk-generators-from-fastapi-sponsors }
+
+このセクションでは、FastAPI をスポンサーしている企業による、**ベンチャー支援**および**企業支援**のソリューションを紹介します。これらの製品は、高品質な生成 SDK に加えて、**追加機能**や**統合**を提供します。
+
+✨ [**FastAPI をスポンサーする**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨ ことで、これらの企業はフレームワークとその**エコシステム**の健全性と**持続可能性**を支援しています。
+
+この支援は、FastAPI の**コミュニティ**(皆さん)への強いコミットメントの表明でもあり、**優れたサービス**の提供だけでなく、堅牢で発展するフレームワーク FastAPI を支える姿勢を示しています。🙇
+
+例えば、次のようなものがあります:
+
+* Speakeasy
+* Stainless
+* liblab
+
+これらのソリューションの中にはオープンソースや無料枠を提供するものもあり、金銭的コミットメントなしで試すことができます。他の商用 SDK ジェネレータも存在し、オンラインで見つけられます。🤓
+
+## TypeScript SDK を作成する { #create-a-typescript-sdk }
+
+まずは簡単な FastAPI アプリから始めます:
+
+{* ../../docs_src/generate_clients/tutorial001_py310.py hl[7:9,12:13,16:17,21] *}
+
+ここで、*path operation* はリクエストとレスポンスのペイロードに使用するモデルを定義しており、`Item` と `ResponseMessage` を使っています。
+
+### API ドキュメント { #api-docs }
+
+`/docs` に移動すると、リクエストで送信・レスポンスで受信するデータの**スキーマ**が表示されます:
+
+
+
+これらのスキーマは、アプリ内でモデルとして宣言されているため表示されます。
+
+その情報はアプリの **OpenAPI スキーマ**に含まれ、API ドキュメントに表示されます。
+
+OpenAPI に含まれるこれらのモデル情報を使って、**クライアントコードを生成**できます。
+
+### Hey API { #hey-api }
+
+モデルを備えた FastAPI アプリがあれば、Hey API で TypeScript クライアントを生成できます。最も手早い方法は npx を使うことです。
+
+```sh
+npx @hey-api/openapi-ts -i http://localhost:8000/openapi.json -o src/client
+```
+
+これで TypeScript SDK が `./src/client` に生成されます。
+
+`@hey-api/openapi-ts` のインストール方法や、生成物の詳細は公式サイトを参照してください。
+
+### SDK の利用 { #using-the-sdk }
+
+これでクライアントコードを import して利用できます。例えば次のようになり、メソッドに対して補完が効きます:
+
+
+
+送信するペイロードにも補完が適用されます:
+
+
+
+/// tip | 豆知識
+
+FastAPI アプリの `Item` モデルで定義した `name` と `price` に補完が効いている点に注目してください。
+
+///
+
+送信データに対するインラインエラーも表示されます:
+
+
+
+レスポンスオブジェクトにも補完があります:
+
+
+
+## タグ付きの FastAPI アプリ { #fastapi-app-with-tags }
+
+実運用ではアプリは大きくなり、*path operation* のグループ分けにタグを使うことが多いでしょう。
+
+例えば **items** 用と **users** 用のセクションがあり、タグで分けられます:
+
+{* ../../docs_src/generate_clients/tutorial002_py310.py hl[21,26,34] *}
+
+### タグ付き TypeScript クライアントの生成 { #generate-a-typescript-client-with-tags }
+
+タグを用いた FastAPI アプリからクライアントを生成すると、通常クライアント側のコードもタグごとに分割されます。
+
+これにより、クライアントコードも正しく整理・グルーピングされます:
+
+
+
+この例では次のようになります:
+
+* `ItemsService`
+* `UsersService`
+
+### クライアントのメソッド名 { #client-method-names }
+
+現状では、生成されるメソッド名(`createItemItemsPost` など)はあまりきれいではありません:
+
+```TypeScript
+ItemsService.createItemItemsPost({name: "Plumbus", price: 5})
+```
+
+これは、クライアントジェネレータが各 *path operation* の OpenAPI 内部の **operation ID** を用いるためです。
+
+OpenAPI では operation ID は全ての *path operation* を通して一意である必要があります。そのため FastAPI は**関数名**、**パス**、**HTTP メソッド/オペレーション**を組み合わせて operation ID を生成し、一意性を保証します。
+
+次にこれを改善する方法を示します。🤓
+
+## カスタム operation ID とより良いメソッド名 { #custom-operation-ids-and-better-method-names }
+
+operation ID の**生成方法**を**変更**して簡潔にし、クライアント側の**メソッド名をシンプル**にできます。
+
+この場合でも各 operation ID が**一意**であることは別の方法で保証する必要があります。
+
+例えば、各 *path operation* にタグを付け、**タグ**と *path operation* の**名前**(関数名)から operation ID を生成できます。
+
+### 一意 ID 生成関数のカスタマイズ { #custom-generate-unique-id-function }
+
+FastAPI は各 *path operation* に**一意 ID**を用いており、これは **operation ID** のほか、必要に応じてリクエストやレスポンスのカスタムモデル名にも使われます。
+
+この関数はカスタマイズ可能です。`APIRoute` を受け取り、文字列を返します。
+
+例えばここでは、最初のタグ(通常は 1 つ)と *path operation* 名(関数名)を使います。
+
+そのカスタム関数を **FastAPI** の `generate_unique_id_function` パラメータに渡します:
+
+{* ../../docs_src/generate_clients/tutorial003_py310.py hl[6:7,10] *}
+
+### カスタム operation ID で TypeScript クライアントを生成 { #generate-a-typescript-client-with-custom-operation-ids }
+
+この状態でクライアントを再生成すると、メソッド名が改善されています:
+
+
+
+ご覧のとおり、メソッド名はタグ名と関数名のみになり、URL パスや HTTP オペレーションの情報は含まれません。
+
+### クライアント生成向けの OpenAPI 仕様の前処理 { #preprocess-the-openapi-specification-for-the-client-generator }
+
+それでも生成コードには**重複情報**が残っています。
+
+`ItemsService`(タグ由来)から items 関連であることはすでに分かるのに、メソッド名にもタグ名が前置されています。😕
+
+OpenAPI 全体としては operation ID の**一意性**のために、このプレフィックスを維持したい場合があるでしょう。
+
+しかし生成クライアント用には、クライアントを生成する直前に OpenAPI の operation ID を**加工**して、メソッド名をより**見やすく**、**クリーン**にできます。
+
+OpenAPI の JSON を `openapi.json` として保存し、次のようなスクリプトで**そのタグのプレフィックスを除去**できます:
+
+{* ../../docs_src/generate_clients/tutorial004_py310.py *}
+
+//// tab | Node.js
+
+```Javascript
+{!> ../../docs_src/generate_clients/tutorial004.js!}
+```
+
+////
+
+これにより operation ID は `items-get_items` のような形から単なる `get_items` に置き換わり、クライアントジェネレータはより簡潔なメソッド名を生成できます。
+
+### 前処理済み OpenAPI から TypeScript クライアントを生成 { #generate-a-typescript-client-with-the-preprocessed-openapi }
+
+生成元が `openapi.json` になったので、入力の場所を更新します:
+
+```sh
+npx @hey-api/openapi-ts -i ./openapi.json -o src/client
+```
+
+新しいクライアントを生成すると、**クリーンなメソッド名**になり、**補完**や**インラインエラー**などもそのまま利用できます:
+
+
+
+## 利点 { #benefits }
+
+自動生成されたクライアントを使うと、次のような対象で**補完**が得られます:
+
+* メソッド
+* 本体のリクエストペイロード、クエリパラメータ等
+* レスポンスのペイロード
+
+また、あらゆる箇所で**インラインエラー**も得られます。
+
+バックエンドコードを更新してフロントエンドを**再生成**すれば、新しい *path operation* はメソッドとして追加され、古いものは削除され、その他の変更も生成コードに反映されます。🤓
+
+つまり、変更があれば自動的にクライアントコードに**反映**されます。クライアントを**ビルド**すれば、使用データに**不整合**があればエラーになります。
+
+その結果、多くのエラーを開発の初期段階で**早期発見**でき、本番で最終ユーザーに不具合が現れてから原因をデバッグする必要がなくなります。✨
diff --git a/docs/ja/docs/advanced/middleware.md b/docs/ja/docs/advanced/middleware.md
new file mode 100644
index 000000000..2883d53d8
--- /dev/null
+++ b/docs/ja/docs/advanced/middleware.md
@@ -0,0 +1,97 @@
+# 高度なミドルウェア { #advanced-middleware }
+
+メインのチュートリアルでは、アプリケーションに[カスタムミドルウェア](../tutorial/middleware.md){.internal-link target=_blank}を追加する方法を学びました。
+
+そして、[`CORSMiddleware` を使った CORS の扱い方](../tutorial/cors.md){.internal-link target=_blank}も学びました。
+
+このセクションでは、その他のミドルウェアの使い方を見ていきます。
+
+## ASGI ミドルウェアの追加 { #adding-asgi-middlewares }
+
+**FastAPI** は Starlette を基盤としており、ASGI 仕様を実装しているため、任意の ASGI ミドルウェアを利用できます。
+
+ミドルウェアは ASGI 仕様に従っていれば、FastAPI や Starlette 専用に作られていなくても動作します。
+
+一般に、ASGI ミドルウェアは最初の引数として ASGI アプリを受け取るクラスです。
+
+そのため、サードパーティの ASGI ミドルウェアのドキュメントでは、おそらく次のように書かれているでしょう:
+
+```Python
+from unicorn import UnicornMiddleware
+
+app = SomeASGIApp()
+
+new_app = UnicornMiddleware(app, some_config="rainbow")
+```
+
+しかし FastAPI(正確には Starlette)は、内部ミドルウェアがサーバーエラーを処理し、カスタム例外ハンドラが正しく動作することを保証する、より簡単な方法を提供しています。
+
+そのためには(CORS の例と同様に)`app.add_middleware()` を使います。
+
+```Python
+from fastapi import FastAPI
+from unicorn import UnicornMiddleware
+
+app = FastAPI()
+
+app.add_middleware(UnicornMiddleware, some_config="rainbow")
+```
+
+`app.add_middleware()` は、最初の引数にミドルウェアのクラスを取り、それ以外の追加引数はミドルウェアに渡されます。
+
+## 組み込みミドルウェア { #integrated-middlewares }
+
+**FastAPI** は一般的なユースケースに対応するいくつかのミドルウェアを含んでいます。以下でその使い方を見ていきます。
+
+/// note | 技術詳細
+
+以下の例では、`from starlette.middleware.something import SomethingMiddleware` を使うこともできます。
+
+**FastAPI** は開発者であるあなたの便宜のために `fastapi.middleware` にいくつかのミドルウェアを提供しています。しかし、利用可能なミドルウェアの多くは Starlette から直接提供されています。
+
+///
+
+## `HTTPSRedirectMiddleware` { #httpsredirectmiddleware }
+
+すべての受信リクエストが `https` または `wss` でなければならないように強制します。
+
+`http` または `ws` への受信リクエストは、安全なスキームにリダイレクトされます。
+
+{* ../../docs_src/advanced_middleware/tutorial001_py310.py hl[2,6] *}
+
+## `TrustedHostMiddleware` { #trustedhostmiddleware }
+
+HTTP Host Header 攻撃を防ぐため、すべての受信リクエストに正しく設定された `Host` ヘッダーを強制します。
+
+{* ../../docs_src/advanced_middleware/tutorial002_py310.py hl[2,6:8] *}
+
+サポートされる引数は次のとおりです:
+
+- `allowed_hosts` - 許可するホスト名のドメイン名リスト。`*.example.com` のようなワイルドカードドメインでサブドメインのマッチングもサポートします。任意のホスト名を許可するには、`allowed_hosts=["*"]` を使うか、このミドルウェアを省略します。
+- `www_redirect` - True に設定すると、許可されたホストの非 www 版へのリクエストを www 版へリダイレクトします。デフォルトは `True` です。
+
+受信リクエストが正しく検証されない場合、`400` のレスポンスが返されます。
+
+## `GZipMiddleware` { #gzipmiddleware }
+
+`Accept-Encoding` ヘッダーに "gzip" を含むリクエストに対して GZip レスポンスを処理します。
+
+このミドルウェアは、通常のレスポンスとストリーミングレスポンスの両方を処理します。
+
+{* ../../docs_src/advanced_middleware/tutorial003_py310.py hl[2,6] *}
+
+サポートされる引数は次のとおりです:
+
+- `minimum_size` - このバイト数の最小サイズ未満のレスポンスは GZip 圧縮しません。デフォルトは `500` です。
+- `compresslevel` - GZip 圧縮時に使用します。1 から 9 までの整数です。デフォルトは `9`。値が小さいほど圧縮は速くなりますがファイルサイズは大きくなり、値が大きいほど圧縮は遅くなりますがファイルサイズは小さくなります。
+
+## その他のミドルウェア { #other-middlewares }
+
+他にも多くの ASGI ミドルウェアがあります。
+
+例えば:
+
+- Uvicorn の `ProxyHeadersMiddleware`
+- MessagePack
+
+他に利用可能なミドルウェアについては、Starlette のミドルウェアドキュメントや ASGI Awesome List を参照してください。
diff --git a/docs/ja/docs/advanced/openapi-callbacks.md b/docs/ja/docs/advanced/openapi-callbacks.md
new file mode 100644
index 000000000..283a80b21
--- /dev/null
+++ b/docs/ja/docs/advanced/openapi-callbacks.md
@@ -0,0 +1,186 @@
+# OpenAPI コールバック { #openapi-callbacks }
+
+あなたは、*path operation* を持つ API を作成し、他者(多くの場合、あなたの API を「利用する」同一の開発者)が作成した *外部 API* へリクエストをトリガーできるようにできます。
+
+あなたの API アプリが *外部 API* を呼び出すときに起きる処理は「コールバック」と呼ばれます。なぜなら、外部開発者が作成したソフトウェアがあなたの API にリクエストを送り、その後であなたの API が「呼び返し」、*外部 API*(おそらく同じ開発者が作成)へリクエストを送るためです。
+
+この場合、その *外部 API* がどのようである「べき」かをドキュメント化したくなるでしょう。どんな *path operation* を持ち、どんなボディを受け取り、どんなレスポンスを返すか、などです。
+
+## コールバックのあるアプリ { #an-app-with-callbacks }
+
+例で見ていきます。
+
+あなたが請求書を作成できるアプリを開発していると想像してください。
+
+これらの請求書は `id`、`title`(任意)、`customer`、`total` を持ちます。
+
+あなたの API の利用者(外部開発者)は、POST リクエストであなたの API に請求書を作成します。
+
+その後、あなたの API は(仮にこうしましょう):
+
+* 外部開発者の顧客に請求書を送ります。
+* 代金を回収します。
+* API 利用者(外部開発者)に通知を送り返します。
+ * これは(あなたの API から)外部開発者が提供する *外部 API* に POST リクエストを送ることで行われます(これが「コールバック」です)。
+
+## 通常の FastAPI アプリ { #the-normal-fastapi-app }
+
+まず、コールバックを追加する前の通常の API アプリがどうなるか見てみましょう。
+
+`Invoice` ボディを受け取り、クエリパラメータ `callback_url` にコールバック用の URL を含める *path operation* を持ちます。
+
+この部分はとても普通で、ほとんどのコードはすでに見覚えがあるはずです:
+
+{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[7:11,34:51] *}
+
+/// tip | 豆知識
+
+`callback_url` クエリパラメータは、Pydantic の Url 型を使用します。
+
+///
+
+唯一の新しい点は、*path operation デコレータ*の引数として `callbacks=invoices_callback_router.routes` を渡すことです。これが何かは次で見ます。
+
+## コールバックのドキュメント化 { #documenting-the-callback }
+
+実際のコールバックのコードは、あなた自身の API アプリに大きく依存します。
+
+そしてアプリごとに大きく異なるでしょう。
+
+それは次のように 1、2 行のコードかもしれません:
+
+```Python
+callback_url = "https://example.com/api/v1/invoices/events/"
+httpx.post(callback_url, json={"description": "Invoice paid", "paid": True})
+```
+
+しかし、おそらくコールバックで最も重要な点は、あなたの API 利用者(外部開発者)が、*あなたの API* がコールバックのリクエストボディなどで送るデータに従って、*外部 API* を正しく実装することを確実にすることです。
+
+そこで次に行うのは、*あなたの API* からのコールバックを受け取るために、その *外部 API* がどうあるべきかをドキュメント化するコードを追加することです。
+
+そのドキュメントはあなたの API の `/docs` の Swagger UI に表示され、外部開発者に *外部 API* の作り方を知らせます。
+
+この例ではコールバック自体は実装しません(それは 1 行のコードでもよいでしょう)。ドキュメント部分のみです。
+
+/// tip | 豆知識
+
+実際のコールバックは単なる HTTP リクエストです。
+
+自分でコールバックを実装する場合は、HTTPX や Requests のようなものを使えます。
+
+///
+
+## コールバックのドキュメント用コードを書く { #write-the-callback-documentation-code }
+
+このコードはあなたのアプリで実行されません。*外部 API* がどうあるべきかをドキュメント化するためだけに必要です。
+
+しかし、あなたはすでに **FastAPI** で API の自動ドキュメントを簡単に作る方法を知っています。
+
+その知識を使って、*外部 API* がどうあるべきかをドキュメント化します……つまり、外部 API が実装すべき *path operation(s)*(あなたの API が呼び出すもの)を作成します。
+
+/// tip | 豆知識
+
+コールバックをドキュメント化するコードを書くときは、あなたがその「外部開発者」だと想像するのが役に立つかもしれません。いま実装しているのは「あなたの API」ではなく、*外部 API* です。
+
+この(外部開発者の)視点を一時的に採用すると、その *外部 API* に対してパラメータ、ボディ用の Pydantic モデル、レスポンスなどをどこに置くのが自然かがより明確に感じられるでしょう。
+
+///
+
+### コールバック用 APIRouter を作成 { #create-a-callback-apirouter }
+
+まず、1 つ以上のコールバックを含む新しい `APIRouter` を作成します。
+
+{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[1,23] *}
+
+### コールバックの path operation を作成 { #create-the-callback-path-operation }
+
+上で作成したのと同じ `APIRouter` を使って、コールバックの *path operation* を作成します。
+
+見た目は通常の FastAPI の *path operation* と同じです:
+
+* 受け取るボディの宣言(例: `body: InvoiceEvent`)が必要でしょう。
+* 返すレスポンスの宣言(例: `response_model=InvoiceEventReceived`)も持てます。
+
+{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[14:16,19:20,26:30] *}
+
+通常の *path operation* と異なる主な点が 2 つあります:
+
+* 実際のコードは不要です。あなたのアプリはこのコードを決して呼びません。これは *外部 API* をドキュメント化するためだけに使われます。したがって、関数本体は `pass` で構いません。
+* *パス* には、*あなたの API* に送られた元のリクエストのパラメータや一部を変数として使える OpenAPI 3 の式(後述)を含められます。
+
+### コールバックのパス式 { #the-callback-path-expression }
+
+コールバックの *パス* には、*あなたの API* に送られた元のリクエストの一部を含められる OpenAPI 3 の式を使用できます。
+
+この例では、`str` は次のとおりです:
+
+```Python
+"{$callback_url}/invoices/{$request.body.id}"
+```
+
+つまり、あなたの API 利用者(外部開発者)が *あなたの API* に次のようにリクエストを送った場合:
+
+```
+https://yourapi.com/invoices/?callback_url=https://www.external.org/events
+```
+
+JSON ボディは:
+
+```JSON
+{
+ "id": "2expen51ve",
+ "customer": "Mr. Richie Rich",
+ "total": "9999"
+}
+```
+
+その後 *あなたの API* は請求書を処理し、のちほど `callback_url`(*外部 API*)へコールバックのリクエストを送ります:
+
+```
+https://www.external.org/events/invoices/2expen51ve
+```
+
+JSON ボディは次のような内容です:
+
+```JSON
+{
+ "description": "Payment celebration",
+ "paid": true
+}
+```
+
+そして *外部 API* からは次のような JSON ボディのレスポンスを期待します:
+
+```JSON
+{
+ "ok": true
+}
+```
+
+/// tip | 豆知識
+
+使用されるコールバック URL には、クエリパラメータ `callback_url`(`https://www.external.org/events`)で受け取った URL と、JSON ボディ内の請求書 `id`(`2expen51ve`)が含まれている点に注目してください。
+
+///
+
+### コールバック用ルーターを追加 { #add-the-callback-router }
+
+これで、上で作成したコールバック用ルーター内に、必要なコールバックの *path operation(s)*(*外部開発者* が *外部 API* に実装すべきもの)が用意できました。
+
+次に、*あなたの API の path operation デコレータ*の `callbacks` パラメータに、そのコールバック用ルーターの属性 `.routes`(実体はルート/*path operations* の `list`)を渡します:
+
+{* ../../docs_src/openapi_callbacks/tutorial001_py310.py hl[33] *}
+
+/// tip | 豆知識
+
+`callback=` に渡すのはルーター本体(`invoices_callback_router`)ではなく、属性 `.routes`(`invoices_callback_router.routes`)である点に注意してください。
+
+///
+
+### ドキュメントを確認 { #check-the-docs }
+
+アプリを起動して http://127.0.0.1:8000/docs にアクセスします。
+
+あなたの *path operation* に「Callbacks」セクションが含まれ、*外部 API* がどうあるべきかが表示されているのが確認できます:
+
+
diff --git a/docs/ja/docs/advanced/openapi-webhooks.md b/docs/ja/docs/advanced/openapi-webhooks.md
new file mode 100644
index 000000000..368cfddd8
--- /dev/null
+++ b/docs/ja/docs/advanced/openapi-webhooks.md
@@ -0,0 +1,55 @@
+# OpenAPI の Webhook { #openapi-webhooks }
+
+アプリがある種の**イベント**を**通知**するために、データ付きで相手のアプリ(リクエスト送信)を呼び出す可能性があることを、API の**ユーザー**に伝えたい場合があります。
+
+これは、通常のようにユーザーがあなたの API にリクエストを送るのではなく、**あなたの API(あなたのアプリ)**が**相手のシステム**(相手の API、アプリ)にリクエストを送る、ということです。
+
+これは一般に**Webhook**と呼ばれます。
+
+## Webhook の手順 { #webhooks-steps }
+
+通常の流れとして、まずあなたのコード内で、送信するメッセージ、すなわちリクエストの**本文(ボディ)**を**定義**します。
+
+加えて、アプリがそれらのリクエスト(イベント)を送信する**タイミング**も何らかの形で定義します。
+
+そして**ユーザー**は、アプリがそのリクエストを送るべき**URL**を(たとえばどこかの Web ダッシュボードで)定義します。
+
+Webhook の URL を登録する方法や実際にリクエストを送るコードなど、これらの**ロジック**はすべてあなた次第です。**あなた自身のコード**で好きなように実装します。
+
+## FastAPI と OpenAPI による Webhook のドキュメント化 { #documenting-webhooks-with-fastapi-and-openapi }
+
+**FastAPI** と OpenAPI を使うと、Webhook の名前、アプリが送信できる HTTP の操作(例: `POST`, `PUT` など)、アプリが送るリクエストの**ボディ**を定義できます。
+
+これにより、ユーザーがあなたの **Webhook** リクエストを受け取るための**API を実装**するのが大幅に簡単になります。場合によっては、ユーザーが自分たちの API コードを自動生成できるかもしれません。
+
+/// info | 情報
+
+Webhook は OpenAPI 3.1.0 以上で利用可能で、FastAPI `0.99.0` 以上が対応しています。
+
+///
+
+## Webhook を持つアプリ { #an-app-with-webhooks }
+
+**FastAPI** アプリケーションを作成すると、`webhooks` という属性があり、ここで *path operations* と同様に(例: `@app.webhooks.post()`)*webhook* を定義できます。
+
+{* ../../docs_src/openapi_webhooks/tutorial001_py310.py hl[9:12,15:20] *}
+
+定義した webhook は **OpenAPI** スキーマおよび自動生成される **ドキュメント UI** に反映されます。
+
+/// info | 情報
+
+`app.webhooks` オブジェクトは実際には単なる `APIRouter` で、複数ファイルでアプリを構成する際に使うものと同じ型です。
+
+///
+
+Webhook では(`/items/` のような)*パス*を宣言しているわけではない点に注意してください。ここで渡す文字列は webhook の**識別子**(イベント名)です。たとえば `@app.webhooks.post("new-subscription")` での webhook 名は `new-subscription` です。
+
+これは、**ユーザー**が実際に Webhook リクエストを受け取りたい**URL パス**を、別の方法(例: Web ダッシュボード)で定義することを想定しているためです。
+
+### ドキュメントの確認 { #check-the-docs }
+
+アプリを起動し、http://127.0.0.1:8000/docs にアクセスします。
+
+ドキュメントには通常の *path operations* に加えて、**webhooks** も表示されます:
+
+
diff --git a/docs/ja/docs/advanced/path-operation-advanced-configuration.md b/docs/ja/docs/advanced/path-operation-advanced-configuration.md
index a78c3cb02..f7e340617 100644
--- a/docs/ja/docs/advanced/path-operation-advanced-configuration.md
+++ b/docs/ja/docs/advanced/path-operation-advanced-configuration.md
@@ -12,7 +12,7 @@ OpenAPIの「エキスパート」でなければ、これはおそらく必要
各オペレーションで一意になるようにする必要があります。
-{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py39.py hl[6] *}
+{* ../../docs_src/path_operation_advanced_configuration/tutorial001_py310.py hl[6] *}
### *path operation関数* の名前をoperationIdとして使用する { #using-the-path-operation-function-name-as-the-operationid }
@@ -20,7 +20,7 @@ APIの関数名を `operationId` として利用したい場合、すべてのAP
すべての *path operation* を追加した後に行うべきです。
-{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py39.py hl[2, 12:21, 24] *}
+{* ../../docs_src/path_operation_advanced_configuration/tutorial002_py310.py hl[2, 12:21, 24] *}
/// tip | 豆知識
@@ -40,7 +40,7 @@ APIの関数名を `operationId` として利用したい場合、すべてのAP
生成されるOpenAPIスキーマ(つまり、自動ドキュメント生成の仕組み)から *path operation* を除外するには、`include_in_schema` パラメータを使用して `False` に設定します。
-{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py39.py hl[6] *}
+{* ../../docs_src/path_operation_advanced_configuration/tutorial003_py310.py hl[6] *}
## docstringによる説明の高度な設定 { #advanced-description-from-docstring }
@@ -92,7 +92,7 @@ OpenAPI仕様では parsed されず、直接 `bytes` として読み取られます。そして `magic_data_reader()` 関数が、何らかの方法でそれをパースする責務を担います。
+この例では、Pydanticモデルを一切宣言していません。実際、リクエストボディはJSONとして パース されず、直接 `bytes` として読み取られます。そして `magic_data_reader()` 関数が、何らかの方法でそれをパースする責務を担います。
それでも、リクエストボディに期待されるスキーマを宣言できます。
@@ -153,7 +153,7 @@ OpenAPI仕様では Starlette のドキュメントを参照してください。
diff --git a/docs/ja/docs/advanced/response-directly.md b/docs/ja/docs/advanced/response-directly.md
index 7e83b9ffb..103e84c38 100644
--- a/docs/ja/docs/advanced/response-directly.md
+++ b/docs/ja/docs/advanced/response-directly.md
@@ -54,7 +54,7 @@
XMLを文字列にし、`Response` に含め、それを返します。
-{* ../../docs_src/response_directly/tutorial002_py39.py hl[1,18] *}
+{* ../../docs_src/response_directly/tutorial002_py310.py hl[1,18] *}
## 備考 { #notes }
diff --git a/docs/ja/docs/advanced/response-headers.md b/docs/ja/docs/advanced/response-headers.md
new file mode 100644
index 000000000..10aec7845
--- /dev/null
+++ b/docs/ja/docs/advanced/response-headers.md
@@ -0,0 +1,41 @@
+# レスポンスヘッダー { #response-headers }
+
+## `Response` パラメータを使う { #use-a-response-parameter }
+
+(Cookie と同様に)*path operation 関数*で `Response` 型のパラメータを宣言できます。
+
+そして、その*一時的*なレスポンスオブジェクトにヘッダーを設定できます。
+
+{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *}
+
+その後は通常どおり、必要な任意のオブジェクト(`dict`、データベースモデルなど)を返せます。
+
+`response_model` を宣言している場合は、返したオブジェクトのフィルタと変換に引き続き使用されます。
+
+**FastAPI** はその*一時的*なレスポンスからヘッダー(Cookie やステータスコードも含む)を取り出し、`response_model` によってフィルタされた返却値を含む最終的なレスポンスに反映します。
+
+また、依存関係の中で `Response` パラメータを宣言し、その中でヘッダー(や Cookie)を設定することもできます。
+
+## `Response` を直接返す { #return-a-response-directly }
+
+`Response` を直接返す場合にもヘッダーを追加できます。
+
+[Response を直接返す](response-directly.md){.internal-link target=_blank} で説明したようにレスポンスを作成し、ヘッダーを追加のパラメータとして渡します:
+
+{* ../../docs_src/response_headers/tutorial001_py310.py hl[10:12] *}
+
+/// note | 技術詳細
+
+`from starlette.responses import Response` や `from starlette.responses import JSONResponse` を使うこともできます。
+
+**FastAPI** は、開発者であるあなたへの便宜として、`starlette.responses` と同じものを `fastapi.responses` として提供しています。しかし、利用可能なレスポンスの大半は直接 Starlette から来ています。
+
+また、`Response` はヘッダーや Cookie を設定するのによく使われるため、**FastAPI** は `fastapi.Response` でも提供しています。
+
+///
+
+## カスタムヘッダー { #custom-headers }
+
+独自のカスタムヘッダーは、`X-` プレフィックスを使って追加できることに注意してください。
+
+ただし、ブラウザのクライアントに見えるようにしたいカスタムヘッダーがある場合は、CORS 設定にそれらを追加する必要があります([CORS (Cross-Origin Resource Sharing)](../tutorial/cors.md){.internal-link target=_blank} を参照)。このとき、Starlette の CORS ドキュメントに記載の `expose_headers` パラメータを使用します。
diff --git a/docs/ja/docs/advanced/security/http-basic-auth.md b/docs/ja/docs/advanced/security/http-basic-auth.md
new file mode 100644
index 000000000..7ee56a039
--- /dev/null
+++ b/docs/ja/docs/advanced/security/http-basic-auth.md
@@ -0,0 +1,107 @@
+# HTTP Basic 認証 { #http-basic-auth }
+
+最もシンプルなケースでは、HTTP Basic 認証を利用できます。
+
+HTTP Basic 認証では、アプリケーションはユーザー名とパスワードを含むヘッダーを期待します。
+
+それを受け取れない場合、HTTP 401 "Unauthorized" エラーを返します。
+
+そして、値が `Basic` のヘッダー `WWW-Authenticate` を、任意の `realm` パラメータとともに返します。
+
+これにより、ブラウザは組み込みのユーザー名とパスワード入力プロンプトを表示します。
+
+その後、そのユーザー名とパスワードを入力すると、ブラウザはそれらをヘッダーに自動的に付与して送信します。
+
+## シンプルな HTTP Basic 認証 { #simple-http-basic-auth }
+
+- `HTTPBasic` と `HTTPBasicCredentials` をインポートします。
+- `HTTPBasic` を使って「`security` スキーム」を作成します。
+- その `security` を依存関係として path operation に使用します。
+- `HTTPBasicCredentials` 型のオブジェクトが返ります:
+ - 送信された `username` と `password` を含みます。
+
+{* ../../docs_src/security/tutorial006_an_py310.py hl[4,8,12] *}
+
+URL を最初に開こうとしたとき(またはドキュメントで「Execute」ボタンをクリックしたとき)、ブラウザはユーザー名とパスワードの入力を求めます:
+
+
+
+## ユーザー名の確認 { #check-the-username }
+
+より完全な例です。
+
+依存関係を使ってユーザー名とパスワードが正しいかを確認します。
+
+これには、Python 標準モジュール `secrets` を用いてユーザー名とパスワードを検証します。
+
+`secrets.compare_digest()` は `bytes` か、ASCII 文字(英語の文字)のみを含む `str` を受け取る必要があります。つまり、`Sebastián` のように `á` を含む文字ではそのままでは動作しません。
+
+これに対処するため、まず `username` と `password` を UTF-8 でエンコードして `bytes` に変換します。
+
+そのうえで、`secrets.compare_digest()` を使って、`credentials.username` が `"stanleyjobson"` であり、`credentials.password` が `"swordfish"` であることを確認します。
+
+{* ../../docs_src/security/tutorial007_an_py310.py hl[1,12:24] *}
+
+これは次のようなコードに相当します:
+
+```Python
+if not (credentials.username == "stanleyjobson") or not (credentials.password == "swordfish"):
+ # Return some error
+ ...
+```
+
+しかし `secrets.compare_digest()` を使うことで、「タイミング攻撃」と呼ばれる種類の攻撃に対して安全になります。
+
+### タイミング攻撃 { #timing-attacks }
+
+「タイミング攻撃」とは何でしょうか?
+
+攻撃者がユーザー名とパスワードを推測しようとしていると想像してください。
+
+そして、ユーザー名 `johndoe`、パスワード `love123` を使ってリクエストを送ります。
+
+その場合、アプリケーション内の Python コードは次のようなものと等価になります:
+
+```Python
+if "johndoe" == "stanleyjobson" and "love123" == "swordfish":
+ ...
+```
+
+しかし、Python は `johndoe` の最初の `j` と `stanleyjobson` の最初の `s` を比較した時点で、両者の文字列が同じでないと判断してすぐに `False` を返します。つまり「残りの文字を比較して計算資源を無駄にする必要はない」と考えるわけです。そしてアプリケーションは「ユーザー名またはパスワードが正しくありません」と返します。
+
+次に、攻撃者がユーザー名 `stanleyjobsox`、パスワード `love123` で試すとします。
+
+アプリケーションのコードは次のようになります:
+
+```Python
+if "stanleyjobsox" == "stanleyjobson" and "love123" == "swordfish":
+ ...
+```
+
+この場合、Python は `stanleyjobsox` と `stanleyjobson` の両方で `stanleyjobso` 全体を比較してから、文字列が同じでないと気づきます。したがって、「ユーザー名またはパスワードが正しくありません」と応答するまでに余分に数マイクロ秒かかります。
+
+#### 応答時間が攻撃者を助ける { #the-time-to-answer-helps-the-attackers }
+
+ここで、サーバーが「ユーザー名またはパスワードが正しくありません」というレスポンスを返すまでに、わずかに長い時間がかかったことに気づけば、攻撃者は何かしら正解に近づいた、すなわち先頭のいくつかの文字が正しかったことを知ることができます。
+
+すると、`johndoe` よりも `stanleyjobsox` に近いものを狙って再試行できます。
+
+#### 「プロ」レベルの攻撃 { #a-professional-attack }
+
+もちろん、攻撃者はこれらを手作業では行わず、プログラムを書いて、1 秒間に数千〜数百万回のテストを行うでしょう。そして 1 回に 1 文字ずつ正しい文字を見つけていきます。
+
+そうすることで、数分から数時間のうちに、攻撃者は私たちのアプリケーションの「助け」(応答にかかった時間)だけを利用して、正しいユーザー名とパスワードを推測できてしまいます。
+
+#### `secrets.compare_digest()` で対策 { #fix-it-with-secrets-compare-digest }
+
+しかし、私たちのコードでは実際に `secrets.compare_digest()` を使用しています。
+
+要するに、`stanleyjobsox` と `stanleyjobson` を比較するのにかかる時間は、`johndoe` と `stanleyjobson` を比較するのにかかる時間と同じになります。パスワードでも同様です。
+
+このように、アプリケーションコードで `secrets.compare_digest()` を使うと、この種の一連のセキュリティ攻撃に対して安全になります。
+
+### エラーを返す { #return-the-error }
+
+認証情報が不正であることを検出したら、ステータスコード 401(認証情報が提供されない場合と同じ)で `HTTPException` を返し、ブラウザに再度ログインプロンプトを表示させるためにヘッダー `WWW-Authenticate` を追加します:
+
+{* ../../docs_src/security/tutorial007_an_py310.py hl[26:30] *}
diff --git a/docs/ja/docs/advanced/security/index.md b/docs/ja/docs/advanced/security/index.md
new file mode 100644
index 000000000..069e2686c
--- /dev/null
+++ b/docs/ja/docs/advanced/security/index.md
@@ -0,0 +1,19 @@
+# 高度なセキュリティ { #advanced-security }
+
+## 追加機能 { #additional-features }
+
+[チュートリアル - ユーザーガイド: セキュリティ](../../tutorial/security/index.md){.internal-link target=_blank}で扱ったもの以外にも、セキュリティを扱うための追加機能がいくつかあります。
+
+/// tip | 豆知識
+
+次の節は必ずしも「高度」ではありません。
+
+あなたのユースケースでは、その中のいずれかに解決策があるかもしれません。
+
+///
+
+## まずチュートリアルを読む { #read-the-tutorial-first }
+
+以下の節は、すでにメインの[チュートリアル - ユーザーガイド: セキュリティ](../../tutorial/security/index.md){.internal-link target=_blank}を読んでいることを前提とします。
+
+いずれも同じ概念に基づいていますが、いくつかの追加機能を利用できます。
diff --git a/docs/ja/docs/advanced/security/oauth2-scopes.md b/docs/ja/docs/advanced/security/oauth2-scopes.md
new file mode 100644
index 000000000..7c6cfdbf0
--- /dev/null
+++ b/docs/ja/docs/advanced/security/oauth2-scopes.md
@@ -0,0 +1,274 @@
+# OAuth2 のスコープ { #oauth2-scopes }
+
+OAuth2 のスコープは **FastAPI** で直接利用でき、シームレスに統合されています。
+
+これにより、OAuth2 標準に従った、よりきめ細かな権限システムを、OpenAPI 対応アプリケーション(および API ドキュメント)に統合できます。
+
+スコープ付きの OAuth2 は、Facebook、Google、GitHub、Microsoft、X (Twitter) など、多くの大手認証プロバイダで使われている仕組みです。ユーザーやアプリケーションに特定の権限を付与するために利用されます。
+
+「Facebook でログイン」「Google でログイン」「GitHub でログイン」「Microsoft でログイン」「X (Twitter) でログイン」するたびに、そのアプリケーションはスコープ付きの OAuth2 を使っています。
+
+この節では、同じスコープ付き OAuth2 を使って、**FastAPI** アプリケーションで認証と認可を管理する方法を見ていきます。
+
+/// warning | 注意
+
+これはやや高度な内容です。はじめたばかりであれば読み飛ばしても構いません。
+
+OAuth2 のスコープは必ずしも必要ではなく、認証と認可は好きなやり方で実装できます。
+
+ただし、スコープ付きの OAuth2 は、API(OpenAPI)や API ドキュメントにきれいに統合できます。
+
+とはいえ、これらのスコープやその他のセキュリティ/認可要件の適用は、必要に応じてコードの中で行う必要があります。
+
+多くの場合、スコープ付き OAuth2 はオーバースペックになりえます。
+
+それでも必要だと分かっている場合や、興味がある場合は、このまま読み進めてください。
+
+///
+
+## OAuth2 のスコープと OpenAPI { #oauth2-scopes-and-openapi }
+
+OAuth2 仕様では、「スコープ」は空白で区切られた文字列の一覧として定義されています。
+
+各文字列の内容は任意ですが、空白は含められません。
+
+これらのスコープは「権限」を表します。
+
+OpenAPI(例: API ドキュメント)では、「セキュリティスキーム」を定義できます。
+
+これらのセキュリティスキームの一つが OAuth2 を使う場合、スコープを宣言して利用できます。
+
+各「スコープ」は、ただの文字列(空白なし)です。
+
+通常、特定のセキュリティ権限を宣言するために使われます。例えば:
+
+- `users:read` や `users:write` は一般的な例です。
+- `instagram_basic` は Facebook / Instagram で使われています。
+- `https://www.googleapis.com/auth/drive` は Google で使われています。
+
+/// info | 情報
+
+OAuth2 において「スコープ」は、必要な特定の権限を宣言する単なる文字列です。
+
+`:` のような他の文字が含まれていても、URL であっても問題ありません。
+
+それらの詳細は実装依存です。
+
+OAuth2 にとっては、単に文字列に過ぎません。
+
+///
+
+## 全体像 { #global-view }
+
+まず、メインの**チュートリアル - ユーザーガイド**にある [OAuth2(パスワード[ハッシュ化あり])、Bearer と JWT トークン](../../tutorial/security/oauth2-jwt.md){.internal-link target=_blank} の例から変更される部分を、スコープ付き OAuth2 を使って手早く見てみましょう。
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[5,9,13,47,65,106,108:116,122:126,130:136,141,157] *}
+
+では、これらの変更を一つずつ確認していきます。
+
+## OAuth2 のセキュリティスキーム { #oauth2-security-scheme }
+
+最初の変更点は、`me` と `items` の 2 つのスコープを持つ OAuth2 セキュリティスキームを宣言していることです。
+
+`scopes` パラメータは、各スコープをキー、その説明を値とする `dict` を受け取ります:
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[63:66] *}
+
+これらのスコープを宣言しているため、ログイン/認可時に API ドキュメントに表示されます。
+
+そして、付与するスコープ(`me`、`items`)を選択できます。
+
+これは、Facebook、Google、GitHub などでログイン時に権限を付与する際と同じ仕組みです:
+
+
+
+## スコープ付きの JWT トークン { #jwt-token-with-scopes }
+
+次に、トークンの path operation を修正して、要求されたスコープを返すようにします。
+
+引き続き同じ `OAuth2PasswordRequestForm` を使用します。これには、リクエストで受け取った各スコープを含む、`str` の `list` である `scopes` プロパティが含まれます。
+
+そして、そのスコープを JWT トークンの一部として返します。
+
+/// danger | 警告
+
+簡単のため、ここでは受け取ったスコープをそのままトークンに追加しています。
+
+しかし、本番アプリケーションではセキュリティのため、ユーザーが実際に持つことができるスコープ、または事前に定義したスコープだけを追加するようにしてください。
+
+///
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[157] *}
+
+## path operation と依存関係でスコープを宣言 { #declare-scopes-in-path-operations-and-dependencies }
+
+ここでは、`/users/me/items/` の path operation が `items` スコープを必要とするように宣言します。
+
+そのために、`fastapi` から `Security` をインポートして使います。
+
+`Security` は(`Depends` と同様に)依存関係を宣言できますが、さらにスコープ(文字列)のリストを受け取る `scopes` パラメータも持ちます。
+
+この場合、`Security` に依存関数 `get_current_active_user` を渡します(`Depends` と同様です)。
+
+加えて、`items` という 1 つのスコープ(複数でも可)を含む `list` も渡します。
+
+依存関数 `get_current_active_user` は、`Depends` だけでなく `Security` でもサブ依存関係を宣言できます。自身のサブ依存関数(`get_current_user`)を宣言し、さらにスコープ要件を追加します。
+
+この場合、`me` スコープを要求します(複数のスコープも可)。
+
+/// note | 備考
+
+異なる場所で異なるスコープを追加する必要は必ずしもありません。
+
+ここでは、**FastAPI** が異なるレベルで宣言されたスコープをどのように扱うかを示すためにそうしています。
+
+///
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[5,141,172] *}
+
+/// info | 技術詳細
+
+`Security` は実際には `Depends` のサブクラスで、後述する追加パラメータが 1 つあるだけです。
+
+しかし `Depends` の代わりに `Security` を使うことで、**FastAPI** はセキュリティスコープを宣言・内部利用でき、OpenAPI で API をドキュメント化できると判断します。
+
+なお、`fastapi` から `Query`、`Path`、`Depends`、`Security` などをインポートする際、それらは実際には特殊なクラスを返す関数です。
+
+///
+
+## `SecurityScopes` を使う { #use-securityscopes }
+
+次に、依存関数 `get_current_user` を更新します。
+
+これは上記の依存関係から使用されます。
+
+ここで、先ほど作成した同じ OAuth2 スキームを依存関係(`oauth2_scheme`)として宣言して使います。
+
+この依存関数自体はスコープ要件を持たないため、`oauth2_scheme` には `Depends` を使えます。セキュリティスコープを指定する必要がない場合は `Security` を使う必要はありません。
+
+さらに、`fastapi.security` からインポートする特別な型 `SecurityScopes` のパラメータを宣言します。
+
+この `SecurityScopes` クラスは `Request` に似ています(`Request` はリクエストオブジェクトを直接取得するために使いました)。
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[9,106] *}
+
+## `scopes` を使う { #use-the-scopes }
+
+パラメータ `security_scopes` は `SecurityScopes` 型になります。
+
+このオブジェクトは、自身およびこれをサブ依存として使うすべての依存関係で要求されるスコープを含む `scopes` プロパティ(リスト)を持ちます。つまり、すべての「依存元」... 少し分かりにくいかもしれませんが、後で再度説明します。
+
+`security_scopes`(`SecurityScopes` クラスのインスタンス)は、要求されたスコープを空白で連結した 1 つの文字列を返す `scope_str` も提供します(これを使います)。
+
+後で複数箇所で再利用(raise)できるように、`HTTPException` を 1 つ作成します。
+
+この例外には、要求されたスコープがあればそれらを空白区切りの文字列(`scope_str` を使用)として含めます。このスコープ文字列は `WWW-Authenticate` ヘッダに入れます(仕様の一部です)。
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[106,108:116] *}
+
+## `username` とデータ構造の検証 { #verify-the-username-and-data-shape }
+
+`username` を取得できていることを確認し、スコープを取り出します。
+
+そして、そのデータを Pydantic モデルで検証します(`ValidationError` 例外を捕捉)。JWT トークンの読み取りや Pydantic によるデータ検証でエラーが発生した場合は、先ほど作成した `HTTPException` を送出します。
+
+そのために、Pydantic モデル `TokenData` に新しいプロパティ `scopes` を追加します。
+
+Pydantic でデータを検証することで、例えばスコープは `str` の `list`、`username` は `str` といった、正確な型になっていることを保証できます。
+
+そうしておけば、例えば誤って `dict` などが入って後でアプリケーションを破壊してしまい、セキュリティリスクになる、といった事態を避けられます。
+
+また、その `username` を持つユーザーが存在することも確認し、存在しなければ、やはり先ほどの例外を送出します。
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[47,117:129] *}
+
+## `scopes` の検証 { #verify-the-scopes }
+
+この依存関数およびすべての依存元(path operation を含む)が要求するすべてのスコープが、受け取ったトークンに含まれていることを検証し、含まれていなければ `HTTPException` を送出します。
+
+そのために、これらすべてのスコープを `str` の `list` として含む `security_scopes.scopes` を使います。
+
+{* ../../docs_src/security/tutorial005_an_py310.py hl[130:136] *}
+
+## 依存関係ツリーとスコープ { #dependency-tree-and-scopes }
+
+依存関係ツリーとスコープをもう一度見てみましょう。
+
+`get_current_active_user` 依存関係は `get_current_user` をサブ依存として持つため、`get_current_active_user` で宣言された `"me"` スコープは、`get_current_user` に渡される `security_scopes.scopes` の必須スコープ一覧に含まれます。
+
+path operation 自体も `"items"` スコープを宣言するため、これも `get_current_user` に渡される `security_scopes.scopes` に含まれます。
+
+依存関係とスコープの階層は次のようになります:
+
+- *path operation* `read_own_items` には:
+ - 依存関係に対して必須スコープ `["items"]` がある:
+ - `get_current_active_user`:
+ - 依存関数 `get_current_active_user` には:
+ - 依存関係に対して必須スコープ `["me"]` がある:
+ - `get_current_user`:
+ - 依存関数 `get_current_user` には:
+ - 自身に必須スコープはない。
+ - `oauth2_scheme` を使う依存関係がある。
+ - `SecurityScopes` 型の `security_scopes` パラメータがある:
+ - この `security_scopes` パラメータは、上で宣言されたすべてのスコープを含む `list` を持つ `scopes` プロパティを持つ。したがって:
+ - *path operation* `read_own_items` では、`security_scopes.scopes` は `["me", "items"]` を含む。
+ - *path operation* `read_users_me` では、`security_scopes.scopes` は `["me"]` を含む。これは依存関係 `get_current_active_user` に宣言されているため。
+ - *path operation* `read_system_status` では、`security_scopes.scopes` は `[]`(空)になる。`scopes` を持つ `Security` を宣言しておらず、その依存関係 `get_current_user` も `scopes` を宣言していないため。
+
+/// tip | 豆知識
+
+重要で「魔法のよう」な点は、`get_current_user` が path operation ごとに異なる `scopes` のリストをチェックすることになる、ということです。
+
+それは、それぞれの path operation と、その path operation の依存関係ツリー内の各依存関係で宣言された `scopes` によって決まります。
+
+///
+
+## `SecurityScopes` の詳細 { #more-details-about-securityscopes }
+
+`SecurityScopes` はどの地点でも、複数箇所でも使えます。「ルート」の依存関係である必要はありません。
+
+常に、その時点の `Security` 依存関係と、**その特定の** path operation と **その特定の** 依存関係ツリーにおける、すべての依存元で宣言されたセキュリティスコープを持ちます。
+
+`SecurityScopes` には依存元で宣言されたすべてのスコープが入るため、トークンが必要なスコープを持っているかどうかを中央の依存関数で検証し、path operation ごとに異なるスコープ要件を宣言する、といった使い方ができます。
+
+これらは path operation ごとに独立して検証されます。
+
+## チェック { #check-it }
+
+API ドキュメントを開くと、認証して、許可するスコープを指定できます。
+
+
+
+どのスコープも選択しない場合は「認証済み」にはなりますが、`/users/me/` や `/users/me/items/` にアクセスしようとすると、権限が不足しているというエラーになります。`/status/` には引き続きアクセスできます。
+
+`me` スコープだけを選択し、`items` スコープを選択しない場合は、`/users/me/` にはアクセスできますが、`/users/me/items/` にはアクセスできません。
+
+これは、ユーザーがアプリケーションに与えた権限の範囲に応じて、サードパーティアプリケーションがこれらの path operation のいずれかに、ユーザーから提供されたトークンでアクセスしようとしたときに起こる動作です。
+
+## サードパーティ統合について { #about-third-party-integrations }
+
+この例では、OAuth2 の「password」フローを使用しています。
+
+これは、(おそらく自前のフロントエンドで)自分たちのアプリケーションにログインする場合に適しています。
+
+自分たちで管理しているため、`username` と `password` を受け取る相手を信頼できるからです。
+
+しかし、他者が接続する OAuth2 アプリケーション(Facebook、Google、GitHub などに相当する認証プロバイダ)を構築する場合は、他のいずれかのフローを使用すべきです。
+
+最も一般的なのは implicit フローです。
+
+最も安全なのは code フローですが、手順が多く実装がより複雑です。複雑なため、多くのプロバイダは結局 implicit フローを推奨することがあります。
+
+/// note | 備考
+
+各認証プロバイダがフローに独自の名称を付け、自社のブランドの一部にするのは一般的です。
+
+しかし、最終的には同じ OAuth2 標準を実装しています。
+
+///
+
+**FastAPI** には、これらすべての OAuth2 認証フロー向けのユーティリティが `fastapi.security.oauth2` に含まれています。
+
+## デコレータ `dependencies` での `Security` { #security-in-decorator-dependencies }
+
+デコレータの `dependencies` パラメータに `Depends` の `list` を定義できるのと同様([path operation デコレータでの依存関係](../../tutorial/dependencies/dependencies-in-path-operation-decorators.md){.internal-link target=_blank} 参照)、ここで `scopes` を指定した `Security` も使用できます。
diff --git a/docs/ja/docs/advanced/settings.md b/docs/ja/docs/advanced/settings.md
new file mode 100644
index 000000000..5508ad6d9
--- /dev/null
+++ b/docs/ja/docs/advanced/settings.md
@@ -0,0 +1,302 @@
+# 設定と環境変数 { #settings-and-environment-variables }
+
+多くの場合、アプリケーションは外部の設定や構成を必要とします。たとえば、シークレットキー、データベース認証情報、メールサービスの認証情報などです。
+
+これらの設定の多くは可変(変更されうる)で、データベースのURLのようなものがあります。また、多くはシークレットのように機微な情報です。
+
+そのため、アプリケーションが読み取る環境変数で提供するのが一般的です。
+
+/// tip | 豆知識
+
+環境変数について理解するには、[環境変数](../environment-variables.md){.internal-link target=_blank}を参照してください。
+
+///
+
+## 型とバリデーション { #types-and-validation }
+
+これらの環境変数は Python の外部にあり、他のプログラムやシステム全体(Linux、Windows、macOS といった異なるOSを含む)と互換性が必要なため、文字列テキストのみを扱えます。
+
+つまり、Python で環境変数から読み取られる値はすべて `str` になり、他の型への変換やバリデーションはコードで行う必要があります。
+
+## Pydantic の `Settings` { #pydantic-settings }
+
+幸いなことに、Pydantic には環境変数から来る設定を扱うための優れたユーティリティがあり、Pydantic: Settings management で提供されています。
+
+### `pydantic-settings` のインストール { #install-pydantic-settings }
+
+まず、[仮想環境](../virtual-environments.md){.internal-link target=_blank}を作成して有効化し、`pydantic-settings` パッケージをインストールします:
+
+
+
+次に、サブアプリケーションのドキュメント http://127.0.0.1:8000/subapi/docs を開きます。
+
+サブアプリケーション用の自動 API ドキュメントが表示され、そのアプリ自身の path operation のみが、正しいサブパス接頭辞 `/subapi` の下で表示されます:
+
+
+
+どちらの UI でも操作すれば正しく動作します。ブラウザがそれぞれのアプリ/サブアプリと通信できるためです。
+
+### 技術詳細: `root_path` { #technical-details-root-path }
+
+上記のようにサブアプリケーションをマウントすると、FastAPI は ASGI 仕様の `root_path` と呼ばれる仕組みを使って、そのサブアプリケーションへのマウントパスを伝播します。
+
+このため、サブアプリケーションはドキュメント UI でそのパス接頭辞を使用すべきことを認識できます。
+
+さらに、サブアプリケーション自身が別のサブアプリケーションをマウントしていても問題ありません。FastAPI がこれらの `root_path` をすべて自動的に処理するためです。
+
+`root_path` の詳細や明示的な指定方法については、[プロキシの背後で](behind-a-proxy.md){.internal-link target=_blank} の節で学べます。
diff --git a/docs/ja/docs/advanced/templates.md b/docs/ja/docs/advanced/templates.md
new file mode 100644
index 000000000..3c4827b88
--- /dev/null
+++ b/docs/ja/docs/advanced/templates.md
@@ -0,0 +1,126 @@
+# テンプレート { #templates }
+
+**FastAPI** では任意のテンプレートエンジンを使用できます。
+
+Flask などでも使われている Jinja2 が一般的な選択肢です。
+
+Starlette によって提供され、**FastAPI** アプリで直接使える、簡単に設定できるユーティリティがあります。
+
+## 依存関係のインストール { #install-dependencies }
+
+[仮想環境](../virtual-environments.md){.internal-link target=_blank} を作成して有効化し、`jinja2` をインストールします:
+
+
-料金を支払います💸。
+やがてあなたの番になり、好きな人と自分のために、とても豪華なハンバーガーを2つ注文します。🍔🍔
-レジ係💁はキッチンの男👨🍳に向かって、あなたのハンバーガー🍔を準備しなければならないと伝えるために何か言いました (彼は現在、前のお客さんの商品を準備していますが)。
+
-レジ係💁はあなたに番号札を渡します。
+レジ係はキッチンの料理人に、あなたのハンバーガーを用意するよう声をかけます (料理人はいま前のお客さんの分を作っています)。
-待っている間、好きな人😍と一緒にテーブルを選んで座り、好きな人😍と長い間話をします (注文したハンバーガーは非常に豪華で、準備に少し時間がかかるので✨🍔✨)。
+
-ハンバーガー🍔を待ちながら好きな人😍とテーブルに座っている間、あなたの好きな人がなんて素晴らしく、かわいくて頭がいいんだと✨😍✨惚れ惚れしながら時間を費やすことができます。
+支払いをします。💸
-好きな人😍と話しながら待っている間、ときどき、カウンターに表示されている番号をチェックして、自分の番かどうかを確認します。
+レジ係はあなたに番号札を渡します。
-その後、ついにあなたの番になりました。カウンターに行き、ハンバーガー🍔を手に入れてテーブルに戻ります。
+
-あなたとあなたの好きな人😍はハンバーガー🍔を食べて、楽しい時間を過ごします✨。
+待っている間、好きな人とテーブルに移動して座り、(豪華なハンバーガーは時間がかかるので) しばらく話します。
+
+テーブルで待っている間、好きな人がどれだけ素敵で、かわいくて、頭が良いかを眺めて時間を過ごせます ✨😍✨。
+
+
+
+時々カウンターの表示を見て、自分の番号になっているか確認します。
+
+やがてあなたの番になります。カウンターに行き、ハンバーガーを受け取り、テーブルに戻ります。
+
+
+
+あなたと好きな人はハンバーガーを食べて、楽しい時間を過ごします。✨
+
+
+
+/// info | 情報
+
+美しいイラストは Ketrina Thompson によるものです。🎨
+
+///
---
-上記のストーリーで、あなたがコンピュータ/プログラム🤖だと想像してみてください。
+この物語で、あなた自身がコンピュータ/プログラム 🤖 だと想像してみてください。
-列にいる間、あなたはアイドル状態です😴。何も「生産的」なことをせず、ただ自分の番を待っています。しかし、レジ係💁は注文を受け取るだけなので (商品の準備をしているわけではない)、列は高速です。したがって、何も問題ありません。
+列にいる間は、何も「生産的」なことをせず、自分の番を待つだけのアイドル状態 😴 です。ただしレジ係は注文を取るだけ (作りはしない) なので列は速く進み、問題ありません。
-それから、あなたの番になったら、実に「生産的な」作業を行います🤓、メニューを確認し、欲しいものを決め、好きな人😍の欲しいものを聞き、料金を支払い💸、現金またはカードを正しく渡したか確認し、正しく清算されたことを確認し、注文が正しく通っているかなどを確認します。
+あなたの番になると、実際に「生産的」な作業をします。メニューを見て注文を決め、好きな人の分も確認し、支払い、正しい紙幣/カードを渡したか、正しく決済されたか、注文内容が正しいかなどを確認します。
-しかし、ハンバーガー🍔をまだできていないので、ハンバーガーの準備ができるまで待機🕙する必要があるため、レジ係💁との作業は「一時停止⏸」になります。
+しかし、ハンバーガーはまだ出来上がっていないので、レジ係とのやり取りは「一時停止」⏸ になります。ハンバーガーができるまで待つ 🕙 必要があるからです。
-しかし、カウンターから離れて、番号札を持ってテーブルに座っているときは、注意を好きな人😍に切り替えて🔀、その上で「仕事⏯🤓」を行なえます。その後、好きな人😍といちゃつくかのような、非常に「生産的な🤓」ことを再び行います。
+ただし、番号札を持ってカウンターから離れテーブルに座れば、注意を好きな人に切り替え 🔀、「その作業」⏯ 🤓 に取り組めます。好きな人といちゃつくという、とても「生産的」🤓 なことがまたできます。
-次に、レジ係💁は、「ハンバーガーの準備ができました🍔」と言って、カウンターのディスプレイに番号を表示しますが、表示番号があなたの番号に変わっても、すぐに狂ったように飛んで行くようなことはありません。あなたは自分の番号札を持っていって、他の人も自分の番号札があるので、あなたのハンバーガー🍔を盗む人がいないことは知っています。
+レジ係 💁 がカウンターの表示にあなたの番号を出して「ハンバーガーができました」と知らせても、あなたは表示が切り替わった瞬間に飛び跳ねたりしません。自分の番号札があり、他の人にもそれぞれ番号札があるので、ハンバーガーを盗られることはないと知っているからです。
-なので、あなたは好きな人😍が話し終えるのを待って (現在の仕事⏯ / 処理中のタスクを終了します🤓)、優しく微笑んで、ハンバーガーを貰ってくるねと言います⏸。
+だから、好きな人の話が終わるのを待ち (現在の作業 ⏯ / 処理中のタスクを完了し 🤓)、微笑んで「ハンバーガー取ってくるね」と言います ⏸。
-次に、カウンターへ、いまから完了する最初のタスク⏯へ向かい、ハンバーガー🍔を受け取り、感謝の意を表して、テーブルに持っていきます。これで、カウンターとのやり取りのステップ/タスクが完了しました⏹。これにより、「ハンバーガーを食べる🔀⏯」という新しいタスクが作成されます。しかし、前の「ハンバーガーを取得する」というタスクは終了しました⏹。
+それからカウンターへ行き 🔀、いま完了した初期のタスク ⏯ に戻って、ハンバーガーを受け取り、礼を言ってテーブルに持っていきます。これでカウンターとのやり取りというステップ/タスクは完了 ⏹ です。その結果として「ハンバーガーを食べる」🔀 ⏯ という新しいタスクが生まれますが、先の「ハンバーガーを受け取る」タスクは完了 ⏹ しています。
-### 並列ハンバーガー
+### 並列ハンバーガー { #parallel-burgers }
-これらが「並行ハンバーガー」ではなく、「並列ハンバーガー」であるとしましょう。
+今度は、これが「並行ハンバーガー」ではなく「並列ハンバーガー」だと想像しましょう。
-あなたは好きな人😍と並列ファストフード🍔を買おうとしています。
+あなたは好きな人と「並列」ファストフードを買いに行きます。
-列に並んでいますが、何人かの料理人兼、レジ係 (8人としましょう) 👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳があなたの前にいる人達の注文を受けつけています。
+複数のレジ係 (例えば 8 人) が同時に料理人でもあり、前の人たちの注文を受けています。
-8人のレジ係がそれぞれ自分で注文を受けるや否や、次の注文を受ける前にハンバーガーを準備するので、あなたの前の人達はカウンターを離れずに、ハンバーガー🍔ができるのを待っています🕙。
+8 人のレジ係はそれぞれ、次の注文を取る前にすぐに調理に取りかかるため、あなたの前の人たちはカウンターを離れず、ハンバーガーができるのを待っています。
-それからいよいよあなたの番になり、好きな人😍と自分のために、2つの非常に豪華なハンバーガー🍔を注文します。
+
-料金を支払います💸。
+ようやくあなたの番になり、好きな人と自分のために豪華なハンバーガーを 2 つ注文します。
-レジ係はキッチンに行きます👨🍳。
+支払いをします 💸。
-あなたはカウンターの前に立って待ちます🕙。番号札がないので誰もあなたよりも先にハンバーガー🍔を取らないようにします。
+
-あなたと好きな人😍は忙しいので、誰もあなたの前に来させませんし、あなたのハンバーガーが到着したとき🕙に誰にも取ることを許しません。あなたは好きな人に注意を払えません😞。
+レジ係はキッチンに向かいます。
-これは「同期」作業であり、レジ係/料理人👨🍳と「同期」します。レジ係/料理人👨🍳がハンバーガー🍔を完成させてあなたに渡すまで待つ🕙必要があり、ちょうどその完成の瞬間にそこにいる必要があります。そうでなければ、他の誰かに取られるかもしれません。
+番号札がないため、他の誰かに先に取られないよう、カウンターの前で立って待ちます 🕙。
-その後、カウンターの前で長い時間待ってから🕙、ついにレジ係/料理人👨🍳がハンバーガー🍔を渡しに戻ってきます。
+
-ハンバーガー🍔を取り、好きな人😍とテーブルに行きます。
+あなたと好きな人は、誰にも割り込まれずハンバーガーが来たらすぐ受け取れるよう見張っているので、好きな人に注意を向けられません。😞
-ただ食べるだけ、それでおしまいです。🍔⏹。
+これは「同期」的な作業です。レジ係/料理人 👨🍳 と「同期」しています。レジ係/料理人 👨🍳 がハンバーガーを作り終えて手渡すその瞬間に、待って 🕙 その場にいなければなりません。そうでないと他の誰かに取られるかもしれません。
-ほとんどの時間、カウンターの前で待つのに費やされていたので🕙、あまり話したりいちゃつくことはありませんでした😞。
+
+
+長い時間 🕙 カウンター前で待った後、ようやくレジ係/料理人 👨🍳 がハンバーガーを持って戻ってきます。
+
+
+
+ハンバーガーを受け取り、好きな人とテーブルに行きます。
+
+食べて、おしまいです。⏹
+
+
+
+ほとんどの時間をカウンター前で待つ 🕙 のに費やしたため、あまり話したり、いちゃついたりできませんでした。😞
+
+/// info | 情報
+
+美しいイラストは Ketrina Thompson によるものです。🎨
+
+///
---
-この並列ハンバーガーのシナリオでは、あなたは2つのプロセッサを備えたコンピュータ/プログラム🤖 (あなたとあなたの好きな人😍) であり、両方とも待機🕙していて、彼らは「カウンターで待機🕙」することに専念しています⏯。
+この「並列ハンバーガー」のシナリオでは、あなたは 2 つのプロセッサ (あなたと好きな人) を持つコンピュータ/プログラム 🤖 で、どちらも長い間 🕙「カウンターでの待機」に注意 ⏯ を専念しています。
-ファストフード店には8つのプロセッサ (レジ係/料理人) 👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳があります。一方、並行ハンバーガー店には2人 (レジ係と料理人) 💁👨🍳しかいなかったかもしれません。
+ファストフード店には 8 個のプロセッサ (レジ係/料理人) があります。一方、並行ハンバーガーの店には (レジ係 1、人、料理人 1 人の) 2 個しかなかったかもしれません。
-しかし、それでも、最終的な体験は最高ではありません😞。
+それでも、最終的な体験は最良とは言えません。😞
---
-これは、ハンバーガー🍔の話と同等な話になります。
+これはハンバーガーにおける並列版の物語です。🍔
より「現実的な」例として、銀行を想像してみてください。
-最近まで、ほとんどの銀行は複数の窓口👨💼👨💼👨💼👨💼に、行列🕙🕙🕙🕙🕙🕙🕙🕙ができていました。
+つい最近まで、ほとんどの銀行には複数の窓口係 👨💼👨💼👨💼👨💼 と長い行列 🕙🕙🕙🕙🕙🕙🕙🕙 がありました。
-すべての窓口で、次々と、一人の客とすべての作業を行います👨💼⏯.
+各窓口係が、一人ずつ、すべての作業を順番に行います 👨💼⏯。
-その上、長時間、列に並ばなければいけません🕙。そうしないと、順番が回ってきません。
+そして、長時間 🕙 行列で待たなければ順番を失います。
-銀行🏦での用事にあなたの好きな人😍を連れて行きたくはないでしょう。
+銀行の用事 🏦 に、好きな人 😍 を連れて行きたいとは思わないでしょう。
-### ハンバーガーのまとめ
+### ハンバーガーのまとめ { #burger-conclusion }
-この「好きな人とのファストフードハンバーガー」のシナリオでは、待機🕙が多いため、並行システム⏸🔀⏯を使用する方がはるかに理にかなっています。
+この「好きな人とファストフード」のシナリオでは、待ち時間 🕙 が多いため、並行システム ⏸🔀⏯ を使う方がはるかに理にかなっています。
-これは、ほとんどのWebアプリケーションに当てはまります。
+これは、ほとんどの Web アプリケーションにも当てはまります。
-多くのユーザーがいますが、サーバーは、あまり強くない回線でのリクエストの送信を待機🕙しています。
+とても多くのユーザーがいますが、サーバは彼らのあまり速くない回線からリクエストが届くのを待ち 🕙、
-そして、レスポンスが返ってくるのをもう一度待機🕙します。
+その後、レスポンスが戻ってくるのをまた待ちます 🕙。
-この「待機🕙」はマイクロ秒単位ですが、それでも、すべて合算すると、最終的にはかなり待機することになります。
+この「待ち」🕙 はマイクロ秒単位で測られますが、すべてを合計すると、結局かなりの待ちになります。
-これが、Web APIへの非同期⏸🔀⏯コードの利用が理にかなっている理由です。
+だからこそ、Web API には非同期 ⏸🔀⏯ コードを使うのが理にかなっています。
-ほとんどの既存の人気のあるPythonフレームワーク (FlaskやDjangoを含む) は、Pythonの新しい非同期機能ができる前に作成されました。したがって、それらをデプロイする方法は、並列実行と、新機能ほど強力ではない古い形式の非同期実行をサポートします。
+これが、NodeJS を人気にした要因 (NodeJS 自体は並列ではありません) であり、プログラミング言語としての Go の強みでもあります。
-しかし、WebSocketのサポートを追加するために、非同期Web Python (ASGI) の主な仕様はDjangoで開発されました。
+そして、それが **FastAPI** で得られるパフォーマンスの水準です。
-そのような非同期性がNodeJSを人気にした理由です (NodeJSは並列ではありませんが)。そして、プログラミング言語としてのGoの強みでもあります。
+さらに、並列性と非同期性を同時に活用できるため、テストされた多くの NodeJS フレームワークより高い性能を発揮し、C に近いコンパイル言語である Go と同等の性能になります (すべて Starlette のおかげです)。
-そして、それは**FastAPI**で得られるパフォーマンスと同じレベルです。
+### 並行処理は並列処理より優れている? { #is-concurrency-better-than-parallelism }
-また、並列処理と非同期処理を同時に実行できるため、テスト済みのほとんどのNodeJSフレームワークよりも高く、Goと同等のパフォーマンスが得られます。Goは、Cに近いコンパイル言語です (Starletteに感謝します)。
+いいえ!それがこの話の教訓ではありません。
-### 並行は並列よりも優れていますか?
+並行処理は並列処理とは異なります。そして多くの待ち時間を伴う**特定の**シナリオでは優れています。そのため、一般に Web アプリ開発では並列処理よりはるかに適しています。しかし、すべてに対して最良というわけではありません。
-いや!それはこの話の教訓ではありません。
+バランスを取るために、次の短い物語を想像してください。
-並行処理は並列処理とは異なります。多くの待機を伴う**特定の**シナリオに適しています。そのため、一般に、Webアプリケーション開発では並列処理よりもはるかに優れています。しかし、すべてに対してより良いというわけではありません。
+> 大きくて汚れた家を掃除しなければならない。
-なので、バランスをとるために、次の物語を想像して下さい:
-
-> あなたは大きくて汚れた家を掃除する必要があります。
-
-*はい、以上です*。
+*はい、これで物語は全部です*。
---
-待機🕙せず、家の中の複数の場所でたくさんの仕事をするだけです。
+どこにも待ち 🕙 はなく、家の複数箇所で大量の作業があるだけです。
-あなたはハンバーガーの例のように、最初はリビングルーム、次にキッチンのように順番にやっていくことができますが、何かを待機🕙しているわけではなく、ただひたすらに掃除をするだけで、順番は何にも影響しません。
+ハンバーガーの例のように順番を決めて、まずリビング、次にキッチン、と進めてもよいのですが、何かを待つ 🕙 わけではなく、ひたすら掃除するだけなので、順番は何も影響しません。
-順番の有無に関係なく (並行に) 同じ時間がかかり、同じ量の作業が行われることになるでしょう。
+順番の有無 (並行性の有無) に関係なく、終了までに同じ時間がかかり、同じ作業量をこなすことになります。
-しかし、この場合、8人の元レジ係/料理人/現役清掃員👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳👨🍳を手配できて、それぞれ (さらにあなたも) が家の別々の場所を掃除できれば、追加の助けを借りて、すべての作業を**並列**に行い、はるかに早く終了できるでしょう。
+しかしこの場合、8 人の元レジ係/料理人/現清掃員を連れてきて、それぞれ (あなたも加えて) 家の別々のエリアを掃除できれば、**並列** に作業でき、より早く終えられます。
-このシナリオでは、清掃員 (あなたを含む) のそれぞれがプロセッサとなり、それぞれの役割を果たします。
+このシナリオでは、各清掃員 (あなたを含む) がプロセッサであり、それぞれが自分の役割を果たします。
-また、実行時間のほとんどは (待機ではなく) 実際の作業に費やされ、コンピュータでの作業はCPUによって行われます。これらの問題は「CPUバウンド」と言います。
+そして実行時間の大半は (待ちではなく) 実作業が占め、コンピュータでの作業は CPU によって行われます。これらの問題は「CPU バウンド」と呼ばれます。
---
-CPUバウンド操作の一般的な例は、複雑な数学処理が必要なものです。
+CPU バウンドな操作の一般的な例は、複雑な数値処理が必要なものです。
例えば:
* **オーディオ** や **画像処理**。
-* **コンピュータビジョン**: 画像は数百万のピクセルで構成され、各ピクセルには3つの値/色があり、通常、これらのピクセルで何かを同時に計算する必要がある処理。
-* **機械学習**: 通常、多くの「行列」と「ベクトル」の乗算が必要です。巨大なスプレッドシートに数字を入れて、それを同時に全部掛け合わせることを考えてみてください。
-* **ディープラーニング**: これは機械学習のサブフィールドであるため、同じことが当てはまります。乗算する数字がある単一のスプレッドシートではなく、それらの膨大な集合で、多くの場合、それらのモデルを構築および/または使用するために特別なプロセッサを使用します。
+* **コンピュータビジョン**: 画像は数百万のピクセルで構成され、各ピクセルには 3 つの値/色があり、通常、それらのピクセル上で同時に何かを計算する必要があります。
+* **機械学習**: 多くの「行列」や「ベクトル」の乗算が必要になります。巨大なスプレッドシートに数字が入っていて、それらを同時にすべて掛け合わせることを想像してください。
+* **ディープラーニング**: 機械学習のサブフィールドなので同様です。掛け合わせる数字が 1 つのスプレッドシートではなく膨大な集合であり、多くの場合、それらのモデルを構築/利用するための特別なプロセッサを使います。
-### 並行処理 + 並列処理: Web + 機械学習
+### 並行処理 + 並列処理: Web + 機械学習 { #concurrency-parallelism-web-machine-learning }
-**FastAPI**を使用すると、Web開発で非常に一般的な並行処理 (NodeJSの主な魅力と同じもの) を利用できます。
+**FastAPI** では、Web 開発で非常に一般的な並行処理 (NodeJS の主な魅力と同じ) を活用できます。
-ただし、機械学習システムのような **CPUバウンド** ワークロードに対して、並列処理とマルチプロセッシング (複数のプロセスが並列で実行される) の利点を活用することもできます。
+同時に、機械学習システムのような **CPU バウンド** なワークロードに対して、並列処理やマルチプロセッシング (複数プロセスの並列実行) の利点も活用できます。
-さらに、Pythonが**データサイエンス**、機械学習、特にディープラーニングの主要言語であるという単純な事実により、FastAPIはデータサイエンス/機械学習のWeb APIおよびアプリケーション (他の多くのアプリケーションとの) に非常によく適合しています。
+さらに、Python が **データサイエンス**、機械学習、特にディープラーニングの主要言語であるという事実も相まって、FastAPI はデータサイエンス/機械学習の Web API やアプリケーション (ほか多数) に非常に適しています。
-本番環境でこの並列処理を実現する方法については、[デプロイ](deployment/index.md){.internal-link target=_blank}に関するセクションを参照してください。
+本番環境でこの並列性を実現する方法は、[デプロイ](deployment/index.md){.internal-link target=_blank} のセクションを参照してください。
-## `async` と `await`
+## `async` と `await` { #async-and-await }
-現代的なバージョンのPythonには、非同期コードを定義する非常に直感的な方法があります。これにより、通常の「シーケンシャル」コードのように見え、適切なタイミングで「待機」します。
+モダンな Python には、非同期コードをとても直感的に定義する方法があります。これにより、通常の「シーケンシャル」なコードのように書けて、適切なタイミングで「待ち」を行ってくれます。
-結果を返す前に待機する必要があり、これらの新しいPython機能をサポートする操作がある場合は、次のようにコーディングできます。
+結果を返す前に待ちが必要で、これらの新しい Python 機能をサポートしている操作がある場合、次のように書けます。
```Python
burgers = await get_burgers(2)
```
-カギは `await` です。結果を `burgers`に保存する前に、`get_burgers(2)`の処理🕙の完了を待つ⏸必要があることをPythonに伝えます。これでPythonは、その間に (別のリクエストを受信するなど) 何か他のことができる🔀⏯ことを知ります。
+ここでの鍵は `await` です。`burgers` に結果を保存する前に、`get_burgers(2)` がやるべきことを終えるのを ⏸ 待つ 🕙 ように Python に伝えます。これにより Python は、その間に (別のリクエストを受け取るなど) ほかのことを 🔀 ⏯ できると分かります。
-`await` が機能するためには、非同期処理をサポートする関数内にある必要があります。これは、`async def` で関数を宣言するだけでよいです:
+`await` が機能するには、この非同期性をサポートする関数の内部でなければなりません。そのためには `async def` で宣言します:
```Python hl_lines="1"
async def get_burgers(number: int):
- # ハンバーガーを作成するために非同期処理を実行
+ # ハンバーガーを作るために非同期の処理を行う
return burgers
```
-...`def` のかわりに:
+...`def` の代わりに:
```Python hl_lines="2"
-# 非同期ではない
+# これは非同期ではない
def get_sequential_burgers(number: int):
- # ハンバーガーを作成するためにシーケンシャルな処理を実行
+ # ハンバーガーを作るためにシーケンシャルな処理を行う
return burgers
```
-`async def` を使用すると、Pythonにその関数内で `await` 式 (その関数の実行を「一時停止⏸」し、結果が戻るまで他の何かを実行🔀する) を認識しなければならないと伝えることができます。
-`async def` 関数を呼び出すときは、「await」しなければなりません。したがって、これは機能しません:
+`async def` を使うと、Python はその関数内で `await` 式に注意し、関数の実行を「一時停止」⏸ してほかのことをしに行き 🔀、戻ってくることができると分かります。
+
+`async def` な関数を呼ぶときは「await」しなければなりません。したがって、次は動きません:
```Python
-# get_burgersはasync defで定義されているので動作しない
+# 動きません。get_burgers は async def で定義されています
burgers = get_burgers(2)
```
---
-したがって、 `await` で呼び出すことができるライブラリを使用している場合は、次のように `async def` を使用して、それを使用する*path operation 関数*を作成する必要があります:
+そのため、`await` で呼べると謳っているライブラリを使っている場合は、それを使う *path operation 関数* を `async def` で作る必要があります。例えば:
```Python hl_lines="2-3"
@app.get('/burgers')
@@ -314,86 +349,96 @@ async def read_burgers():
return burgers
```
-### より発展的な技術詳細
+### より発展的な技術詳細 { #more-technical-details }
-`await` は `async def` で定義された関数内でのみ使用できることがわかったかと思います。
+`await` は `async def` で定義された関数の内部でしか使えないことに気づいたかもしれません。
-しかし同時に、`async def` で定義された関数は「awaitされる」必要があります。なので、`async def` を持つ関数は、`async def` で定義された関数内でのみ呼び出せます。
+同時に、`async def` で定義された関数は「await」される必要があります。つまり、`async def` を持つ関数は、やはり `async def` で定義された関数の内部からしか呼べません。
-では、このニワトリと卵の問題について、最初の `async` 関数をどのように呼び出すのでしょうか?
+では、ニワトリと卵の話のように、最初の `async` 関数はどう呼ぶのでしょうか?
-**FastAPI**を使用している場合、その「最初の」関数が*path operation 関数*であり、FastAPIが正しく実行する方法を知っているので、心配する必要はありません。
+**FastAPI** を使っている場合は心配ありません。その「最初の」関数は *path operation 関数* で、FastAPI が適切に実行してくれます。
-しかし、FastAPI以外で `async` / `await` を使用したい場合は、公式Pythonドキュメントを参照して下さい。
+しかし、FastAPI を使わずに `async` / `await` を使いたい場合もあります。
-### 非同期コードの他の形式
+### 自分で async コードを書く { #write-your-own-async-code }
-`async` と `await` を使用するスタイルは、この言語では比較的新しいものです。
+Starlette (**FastAPI** も) は AnyIO の上に構築されており、標準ライブラリの asyncio と Trio の両方に対応しています。
-非同期コードの操作がはるかに簡単になります。
+特に、あなた自身のコード内で、より高度なパターンを必要とする発展的な並行処理のユースケースに対して、AnyIO を直接使えます。
-等価な (またはほとんど同一の) 構文が、最近のバージョンのJavaScript (ブラウザおよびNodeJS) にも最近組み込まれました。
+仮に FastAPI を使っていなくても、AnyIO で独自の async アプリケーションを書けば、高い互換性と利点 (例: 構造化並行性) を得られます。
-しかし、その前は、非同期コードの処理はかなり複雑で難解でした。
+私は AnyIO の上に薄い層として、型注釈を少し改善し、より良い**補完**や**インラインエラー**などを得るための別ライブラリも作りました。また、**理解**して**自分で async コードを書く**のに役立つフレンドリーなイントロ/チュートリアルもあります: Asyncer。特に、**async コードと通常の** (ブロッキング/同期) **コードを組み合わせる**必要がある場合に有用です。
-以前のバージョンのPythonでは、スレッドやGeventが利用できました。しかし、コードは理解、デバック、そして、考察がはるかに複雑です。
+### 非同期コードの他の形式 { #other-forms-of-asynchronous-code }
-以前のバージョンのNodeJS / ブラウザJavaScriptでは、「コールバック」を使用していました。これは、「コールバック地獄」につながります。
+`async` と `await` を使うこのスタイルは、言語としては比較的新しいものです。
-## コルーチン
+しかし、これにより非同期コードの取り扱いは大幅に簡単になります。
-**コルーチン**は、`async def` 関数によって返されるものを指す非常に洒落た用語です。これは、開始できて、いつか終了する関数のようなものであるが、内部に `await` があるときは内部的に一時停止⏸されることもあるものだとPythonは認識しています。
+同等 (ほぼ同一) の構文が最近の JavaScript (ブラウザと NodeJS) にも導入されました。
-`async` と `await` を用いた非同期コードを使用するすべての機能は、「コルーチン」を使用するものとして何度もまとめられています。Goの主要機能である「ゴルーチン」に相当します。
+それ以前は、非同期コードの扱いはかなり複雑で難解でした。
-## まとめ
+以前の Python ではスレッドや Gevent を使えましたが、コードの理解・デバッグ・思考がはるかに難しくなります。
-上述したフレーズを見てみましょう:
+以前の NodeJS / ブラウザ JavaScript では「コールバック」を使っており、「コールバック地獄」を招きました。
-> 現代版のPythonは「**非同期コード**」を、「**コルーチン**」と称されるものを利用してサポートしています。これは **`async` と `await`** 構文を用います。
+## コルーチン { #coroutines }
-今では、この意味がより理解できるはずです。✨
+**コルーチン**は、`async def` 関数が返すものを指す、ちょっと洒落た用語です。Python はそれを、開始できていつか終了する関数のようなものとして扱いますが、内部に `await` があるたびに内部的に一時停止 ⏸ するかもしれないものとして認識します。
-(Starletteを介して) FastAPIに力を与えて、印象的なパフォーマンスを実現しているものはこれがすべてです。
+`async` と `await` を用いた非同期コードの機能全体は、しばしば「コルーチンを使う」と要約されます。これは Go の主要機能「Goroutines」に相当します。
-## 非常に発展的な技術的詳細
+## まとめ { #conclusion }
+
+上のフレーズをもう一度見てみましょう:
+
+> モダンな Python は **「非同期コード」** を **「コルーチン」** と呼ばれる仕組みでサポートしており、構文は **`async` と `await`** です。
+
+今なら、より意味が分かるはずです。✨
+
+これらすべてが (Starlette を通じて) FastAPI を支え、印象的なパフォーマンスを実現しています。
+
+## 非常に発展的な技術的詳細 { #very-technical-details }
/// warning | 注意
-恐らくスキップしても良いでしょう。
+おそらく読み飛ばしても大丈夫です。
-この部分は**FastAPI**の仕組みに関する非常に技術的な詳細です。
+これは **FastAPI** の内部動作に関する、とても技術的な詳細です。
-かなりの技術知識 (コルーチン、スレッド、ブロッキングなど) があり、FastAPIが `async def` と通常の `def` をどのように処理するか知りたい場合は、先に進んでください。
+(コルーチン、スレッド、ブロッキング等の) 技術知識があり、FastAPI が `async def` と通常の `def` をどう扱うかに興味がある場合は、読み進めてください。
///
-### Path operation 関数
+### Path operation 関数 { #path-operation-functions }
-*path operation 関数*を `async def` の代わりに通常の `def` で宣言すると、(サーバーをブロックするので) 直接呼び出す代わりに外部スレッドプール (awaitされる) で実行されます。
+*path operation 関数* を `async def` ではなく通常の `def` で宣言した場合、(サーバをブロックしてしまうため) 直接呼び出されるのではなく、外部のスレッドプールで実行され、それを待機します。
-上記の方法と違った方法の別の非同期フレームワークから来ており、小さなパフォーマンス向上 (約100ナノ秒) のために通常の `def` を使用して些細な演算のみ行う *path operation 関数* を定義するのに慣れている場合は、**FastAPI**ではまったく逆の効果になることに注意してください。このような場合、*path operation 関数* がブロッキングI/Oを実行しないのであれば、`async def` の使用をお勧めします。
+上記とは異なる動作の別の非同期フレームワークから来ており、ほんのわずかなパフォーマンス向上 (約 100 ナノ秒) を狙って、計算のみの些細な *path operation 関数* を素の `def` で定義することに慣れている場合、**FastAPI** では効果がまったく逆になる点に注意してください。これらの場合、*path operation 関数* がブロッキングな I/O を行うコードを使っていない限り、`async def` を使った方が良いです。
-それでも、どちらの状況でも、**FastAPI**が過去のフレームワークよりも (またはそれに匹敵するほど) [高速になる](index.md#_10){.internal-link target=_blank}可能性があります。
+それでも、どちらの状況でも、**FastAPI** はあなたが以前使っていたフレームワークよりも (少なくとも同等に) [高速である](index.md#performance){.internal-link target=_blank} 可能性が高いです。
-### 依存関係
+### 依存関係 { #dependencies }
-依存関係についても同様です。依存関係が `async def` ではなく標準の `def` 関数である場合、外部スレッドプールで実行されます。
+[依存関係](tutorial/dependencies/index.md){.internal-link target=_blank} についても同様です。依存関係が `async def` ではなく標準の `def` 関数である場合、外部のスレッドプールで実行されます。
-### サブ依存関係
+### サブ依存関係 { #sub-dependencies }
-(関数定義のパラメーターとして) 相互に必要な複数の依存関係とサブ依存関係を設定できます。一部は `async def` で作成され、他の一部は通常の `def` で作成されます。それでも動作し、通常の `def`で作成されたものは、「awaitされる」代わりに (スレッドプールから) 外部スレッドで呼び出されます。
+複数の依存関係や [サブ依存関係](tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} を (関数定義のパラメータとして) 相互に要求させられます。その一部は `async def`、他は通常の `def` で作られていても動作します。通常の `def` で作られたものは「await」される代わりに、外部スレッドプールからスレッド上で呼び出されます。
-### その他のユーティリティ関数
+### その他のユーティリティ関数 { #other-utility-functions }
-あなたが直接呼び出すユーティリティ関数は通常の `def` または `async def` で作成でき、FastAPIは呼び出す方法に影響を与えません。
+あなたが直接呼び出すユーティリティ関数は、通常の `def` でも `async def` でも構いません。FastAPI はその呼び出し方に影響を与えません。
-これは、FastAPIが呼び出す関数と対照的です: *path operation 関数*と依存関係。
+これは、FastAPI があなたの代わりに呼び出す関数 (すなわち *path operation 関数* と依存関係) とは対照的です。
-ユーティリティ関数が `def` を使用した通常の関数である場合、スレッドプールではなく直接 (コードで記述したとおりに) 呼び出されます。関数が `async def` を使用して作成されている場合は、呼び出す際に `await` する必要があります。
+ユーティリティ関数が `def` の通常関数であれば、(あなたのコードに書いたとおりに) 直接呼び出され、スレッドプールでは実行されません。関数が `async def` で作られている場合は、その関数を呼ぶときに `await` すべきです。
---
-繰り返しになりますが、これらは非常に技術的な詳細であり、検索して辿り着いた場合は役立つでしょう。
+繰り返しになりますが、これらは非常に技術的な詳細で、該当事項を検索してここにたどり着いた場合には役立つでしょう。
-それ以外の場合は、上記のセクションのガイドラインで問題ないはずです: 急いでいますか?。
+それ以外の場合は、上のセクションのガイドラインに従えば十分です: 急いでいますか?。
diff --git a/docs/ja/docs/deployment/cloud.md b/docs/ja/docs/deployment/cloud.md
new file mode 100644
index 000000000..17699cdca
--- /dev/null
+++ b/docs/ja/docs/deployment/cloud.md
@@ -0,0 +1,24 @@
+# クラウドプロバイダへの FastAPI デプロイ { #deploy-fastapi-on-cloud-providers }
+
+FastAPI アプリケーションは、実質的にどのようなクラウドプロバイダでもデプロイできます。
+
+多くの場合、主要なクラウドプロバイダは FastAPI をデプロイするためのガイドを提供しています。
+
+## FastAPI Cloud { #fastapi-cloud }
+
+**FastAPI Cloud** は、**FastAPI** の作者と同じチームによって作られています。
+
+API の**構築**、**デプロイ**、**アクセス**までのプロセスを、最小限の手間で効率化します。
+
+FastAPI でアプリを開発するときと同じ**開発者体験**を、クラウドへの**デプロイ**にももたらします。🎉
+
+FastAPI Cloud は、*FastAPI and friends* オープンソースプロジェクトの主要なスポンサーかつ資金提供元です。✨
+
+## クラウドプロバイダ - スポンサー { #cloud-providers-sponsors }
+
+他にもいくつかのクラウドプロバイダが ✨ [**FastAPI をスポンサーしています**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} ✨。🙇
+
+それらのガイドを参考にし、サービスを試してみるのもよいでしょう:
+
+* Render
+* Railway
diff --git a/docs/ja/docs/deployment/concepts.md b/docs/ja/docs/deployment/concepts.md
index 787eb2e73..501a90bc9 100644
--- a/docs/ja/docs/deployment/concepts.md
+++ b/docs/ja/docs/deployment/concepts.md
@@ -29,7 +29,6 @@
## セキュリティ - HTTPS { #security-https }
-
[前チャプターのHTTPSについて](https.md){.internal-link target=_blank}では、HTTPSがどのようにAPIを暗号化するのかについて学びました。
通常、アプリケーションサーバにとって**外部の**コンポーネントである**TLS Termination Proxy**によって提供されることが一般的です。このプロキシは通信の暗号化を担当します。
@@ -193,7 +192,6 @@ FastAPI アプリケーションでは、Uvicorn を実行する `fastapi` コ
同じAPIプログラムの**複数のプロセス**を実行する場合、それらは一般的に**Worker/ワーカー**と呼ばれます。
### ワーカー・プロセス と ポート { #worker-processes-and-ports }
-
[HTTPSについて](https.md){.internal-link target=_blank}のドキュメントで、1つのサーバーで1つのポートとIPアドレスの組み合わせでリッスンできるのは1つのプロセスだけであることを覚えていますでしょうか?
diff --git a/docs/ja/docs/deployment/docker.md b/docs/ja/docs/deployment/docker.md
index 6c182448c..883f98c98 100644
--- a/docs/ja/docs/deployment/docker.md
+++ b/docs/ja/docs/deployment/docker.md
@@ -14,7 +14,7 @@ Linuxコンテナの使用には、**セキュリティ**、**反復可能性(
-**FastAPI**は、代替ツールのこれまでの働きがなければ存在しなかったでしょう。 +**FastAPI**は、他の人々のこれまでの働きがなければ存在しなかったでしょう。 以前に作られた多くのツールが、作成における刺激として役立ってきました。 @@ -29,7 +28,7 @@-## 調査 +## 調査 { #investigation } すべて既存の代替手段を使うことで、そのすべてを学び、アイデアを得て、自分や一緒に仕事をしてきた開発者のチームにとって最良の方法で組み合わせる機会を得ました。 @@ -39,7 +38,7 @@ そこで、**FastAPI**のコードを書き始める前に、OpenAPI、JSON Schema、OAuth2などの仕様を数ヶ月かけて勉強し、それらの関係、重複する箇所、相違点を理解しました。 -## 設計 +## 設計 { #design } その後、 (FastAPIを使う開発者として) ユーザーが欲しい「API」の設計に時間を費やしました。 @@ -53,19 +52,19 @@ すべての箇所で、すべての開発者に最高の開発体験を提供しました。 -## 要件 +## 要件 { #requirements } いくつかの代替手法を試したあと、私は**Pydantic**の強みを利用することを決めました。 そして、JSON Schemaに完全に準拠するようにしたり、制約宣言を定義するさまざまな方法をサポートしたり、いくつかのエディターでのテストに基づいてエディターのサポート (型チェック、自動補完) を改善するために貢献しました。 -開発中、もう1つの重要な鍵となる**Starlette**、にも貢献しました。 +開発中、もう1つの重要な鍵となる**Starlette**にも貢献しました。 -## 開発 +## 開発 { #development } 私が**FastAPI**自体の作成を開始した時には、ほとんどの部分がすでに準備されており、設計が定義され、必要な条件とツールの準備ができていました。そして規格や仕様に関する知識が、明確になり、更新されていました。 -## これから +## これから { #future } この時点ですでに、これらのアイデアを持った**FastAPI**が多くの人の役に立っていることは明らかです。 diff --git a/docs/ja/docs/how-to/authentication-error-status-code.md b/docs/ja/docs/how-to/authentication-error-status-code.md new file mode 100644 index 000000000..9bef47644 --- /dev/null +++ b/docs/ja/docs/how-to/authentication-error-status-code.md @@ -0,0 +1,17 @@ +# 古い 403 認証エラーのステータスコードを使う { #use-old-403-authentication-error-status-codes } + +FastAPI バージョン `0.122.0` より前は、統合されたセキュリティユーティリティが認証に失敗してクライアントへエラーを返す際、HTTP ステータスコード `403 Forbidden` を使用していました。 + +FastAPI バージョン `0.122.0` 以降では、より適切な HTTP ステータスコード `401 Unauthorized` を使用し、HTTP 仕様に従ってレスポンスに妥当な `WWW-Authenticate` ヘッダーを含めます。RFC 7235、RFC 9110。 + +しかし、何らかの理由でクライアントが従来の挙動に依存している場合は、セキュリティクラスでメソッド `make_not_authenticated_error` をオーバーライドすることで、その挙動に戻せます。 + +たとえば、既定の `401 Unauthorized` エラーの代わりに `403 Forbidden` エラーを返す `HTTPBearer` のサブクラスを作成できます: + +{* ../../docs_src/authentication_error_status_code/tutorial001_an_py310.py hl[9:13] *} + +/// tip | 豆知識 + +この関数は例外インスタンスを返す点に注意してください。ここでは例外を送出しません。送出は内部の他のコードで行われます。 + +/// diff --git a/docs/ja/docs/how-to/conditional-openapi.md b/docs/ja/docs/how-to/conditional-openapi.md index 9478f5c03..0febe1ef6 100644 --- a/docs/ja/docs/how-to/conditional-openapi.md +++ b/docs/ja/docs/how-to/conditional-openapi.md @@ -10,7 +10,7 @@ もしセキュリティ上の欠陥がソースコードにあるならば、それは存在したままです。 -ドキュメンテーションを非表示にするのは、単にあなたのAPIへのアクセス方法を難解にするだけでなく、同時にあなた自身の本番環境でのAPIのデバッグを困難にしてしまう可能性があります。単純に、 Security through obscurity の一つの形態として考えられるでしょう。 +ドキュメンテーションを非表示にするのは、単にあなたのAPIへのアクセス方法を難解にするだけでなく、同時にあなた自身の本番環境でのAPIのデバッグを困難にしてしまう可能性があります。単純に、 秘匿によるセキュリティ の一つの形態として考えられるでしょう。 もしあなたのAPIのセキュリティを強化したいなら、いくつかのよりよい方法があります。例を示すと、 @@ -29,7 +29,7 @@ 例えば、 -{* ../../docs_src/conditional_openapi/tutorial001_py39.py hl[6,11] *} +{* ../../docs_src/conditional_openapi/tutorial001_py310.py hl[6,11] *} ここでは `openapi_url` の設定を、デフォルトの `"/openapi.json"` のまま宣言しています。 diff --git a/docs/ja/docs/how-to/configure-swagger-ui.md b/docs/ja/docs/how-to/configure-swagger-ui.md new file mode 100644 index 000000000..8be7adc84 --- /dev/null +++ b/docs/ja/docs/how-to/configure-swagger-ui.md @@ -0,0 +1,70 @@ +# Swagger UI の設定 { #configure-swagger-ui } + +いくつかの追加の Swagger UI パラメータを設定できます。 + +設定するには、`FastAPI()` のアプリオブジェクトを作成するとき、または `get_swagger_ui_html()` 関数に `swagger_ui_parameters` 引数を渡します。 + +`swagger_ui_parameters` は、Swagger UI に直接渡される設定を含む辞書を受け取ります。 + +FastAPI はそれらの設定を **JSON** に変換し、JavaScript と互換にします。Swagger UI が必要とするのはこの形式です。 + +## シンタックスハイライトを無効化 { #disable-syntax-highlighting } + +例えば、Swagger UI のシンタックスハイライトを無効化できます。 + +設定を変更しなければ、シンタックスハイライトはデフォルトで有効です: + +
+
+しかし、`syntaxHighlight` を `False` に設定すると無効化できます:
+
+{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *}
+
+...その場合、Swagger UI ではシンタックスハイライトが表示されなくなります:
+
+
+
+## テーマの変更 { #change-the-theme }
+
+同様に、キー `"syntaxHighlight.theme"`(途中にドットが含まれている点に注意)でシンタックスハイライトのテーマを設定できます:
+
+{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *}
+
+この設定により、シンタックスハイライトの配色テーマが変わります:
+
+
+
+## 既定の Swagger UI パラメータの変更 { #change-default-swagger-ui-parameters }
+
+FastAPI には、多くのユースケースに適した既定の設定パラメータが含まれています。
+
+既定では次の設定が含まれます:
+
+{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *}
+
+引数 `swagger_ui_parameters` に別の値を指定することで、これらを上書きできます。
+
+例えば、`deepLinking` を無効化するには、次の設定を `swagger_ui_parameters` に渡します:
+
+{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *}
+
+## その他の Swagger UI パラメータ { #other-swagger-ui-parameters }
+
+利用可能な他のすべての設定については、公式の Swagger UI パラメータのドキュメントを参照してください。
+
+## JavaScript 専用の設定 { #javascript-only-settings }
+
+Swagger UI では、他にも **JavaScript 専用** のオブジェクト(例: JavaScript の関数)による設定が可能です。
+
+FastAPI には、次の JavaScript 専用の `presets` 設定も含まれています:
+
+```JavaScript
+presets: [
+ SwaggerUIBundle.presets.apis,
+ SwaggerUIBundle.SwaggerUIStandalonePreset
+]
+```
+
+これらは文字列ではなく **JavaScript** のオブジェクトであるため、Python のコードから直接渡すことはできません。
+
+そのような JavaScript 専用の設定を使う必要がある場合は、上記のいずれかの方法を使用し、Swagger UI の path operation をオーバーライドして、必要な JavaScript を手動で記述してください。
diff --git a/docs/ja/docs/how-to/custom-docs-ui-assets.md b/docs/ja/docs/how-to/custom-docs-ui-assets.md
new file mode 100644
index 000000000..c0c9745b2
--- /dev/null
+++ b/docs/ja/docs/how-to/custom-docs-ui-assets.md
@@ -0,0 +1,185 @@
+# カスタムドキュメント UI の静的アセット(セルフホスティング) { #custom-docs-ui-static-assets-self-hosting }
+
+API ドキュメントは **Swagger UI** と **ReDoc** を使用しており、それぞれにいくつかの JavaScript と CSS ファイルが必要です。
+
+既定では、これらのファイルは CDN から配信されます。
+
+しかし、カスタマイズすることも可能で、特定の CDN を指定したり、自分でファイルを配信したりできます。
+
+## JavaScript と CSS のカスタム CDN { #custom-cdn-for-javascript-and-css }
+
+別の CDN を使いたいとします。例えば `https://unpkg.com/` を使いたい場合です。
+
+例えば、一部の URL が制限されている国に住んでいる場合に役立ちます。
+
+### 自動ドキュメントの無効化 { #disable-the-automatic-docs }
+
+最初の手順は自動ドキュメントを無効化することです。デフォルトではそれらは既定の CDN を使用します。
+
+無効化するには、`FastAPI` アプリ作成時にそれらの URL を `None` に設定します:
+
+{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[8] *}
+
+### カスタムドキュメントの追加 { #include-the-custom-docs }
+
+これで、カスタムドキュメント用の *path operations* を作成できます。
+
+FastAPI の内部関数を再利用してドキュメント用の HTML ページを生成し、必要な引数を渡せます:
+
+- `openapi_url`: ドキュメントの HTML ページが API の OpenAPI スキーマを取得する URL。ここでは属性 `app.openapi_url` を使用できます。
+- `title`: API のタイトル。
+- `oauth2_redirect_url`: 既定値を使うにはここで `app.swagger_ui_oauth2_redirect_url` を使用できます。
+- `swagger_js_url`: Swagger UI ドキュメント用の HTML が取得する JavaScript ファイルの URL。これはカスタム CDN の URL です。
+- `swagger_css_url`: Swagger UI ドキュメント用の HTML が取得する CSS ファイルの URL。これはカスタム CDN の URL です。
+
+ReDoc についても同様です...
+
+{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[2:6,11:19,22:24,27:33] *}
+
+/// tip | 豆知識
+
+`swagger_ui_redirect` 用の *path operation* は、OAuth2 を使用する場合の補助です。
+
+API を OAuth2 プロバイダと統合すると、認証を実行して取得したクレデンシャルを持った状態で API ドキュメントに戻れます。そして実際の OAuth2 認証を用いてドキュメント上から API と対話できます。
+
+Swagger UI がこの処理を裏側で行いますが、そのためにこの「redirect」の補助が必要です。
+
+///
+
+### テスト用の *path operation* を作成 { #create-a-path-operation-to-test-it }
+
+すべてが動作するかをテストできるように、*path operation* を作成します:
+
+{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *}
+
+### テスト { #test-it }
+
+これで、http://127.0.0.1:8000/docs にアクセスしてページを再読み込みすると、新しい CDN からそれらのアセットが読み込まれるはずです。
+
+## ドキュメント用 JavaScript と CSS のセルフホスティング { #self-hosting-javascript-and-css-for-docs }
+
+オフライン(インターネット非接続)でも、あるいはローカルネットワークで、アプリを動作させたい場合などには、JavaScript と CSS をセルフホストするのが有用です。
+
+ここでは、同じ FastAPI アプリ内でそれらのファイルを配信し、ドキュメントでそれらを使用するように設定する方法を示します。
+
+### プロジェクトのファイル構成 { #project-file-structure }
+
+プロジェクトのファイル構成が次のようになっているとします:
+
+```
+.
+├── app
+│ ├── __init__.py
+│ ├── main.py
+```
+
+これらの静的ファイルを保存するためのディレクトリを作成します。
+
+新しいファイル構成は次のようになります:
+
+```
+.
+├── app
+│ ├── __init__.py
+│ ├── main.py
+└── static/
+```
+
+### ファイルのダウンロード { #download-the-files }
+
+ドキュメントに必要な静的ファイルをダウンロードし、`static/` ディレクトリに配置します。
+
+各リンクを右クリックして「リンク先を別名で保存...」のようなオプションを選べます。
+
+**Swagger UI** では次のファイルを使用します:
+
+- `swagger-ui-bundle.js`
+- `swagger-ui.css`
+
+そして **ReDoc** では次のファイルを使用します:
+
+- `redoc.standalone.js`
+
+その後、ファイル構成は次のようになります:
+
+```
+.
+├── app
+│ ├── __init__.py
+│ ├── main.py
+└── static
+ ├── redoc.standalone.js
+ ├── swagger-ui-bundle.js
+ └── swagger-ui.css
+```
+
+### 静的ファイルの配信 { #serve-the-static-files }
+
+- `StaticFiles` をインポートします。
+- 特定のパスに `StaticFiles()` インスタンスを「マウント」します。
+
+{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[7,11] *}
+
+### 静的ファイルのテスト { #test-the-static-files }
+
+アプリケーションを起動し、http://127.0.0.1:8000/static/redoc.standalone.js にアクセスします。
+
+**ReDoc** 用の非常に長い JavaScript ファイルが表示されるはずです。
+
+先頭は次のようになっているかもしれません:
+
+```JavaScript
+/*! For license information please see redoc.standalone.js.LICENSE.txt */
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("null")):
+...
+```
+
+これで、アプリから静的ファイルを配信できていること、そしてドキュメント用の静的ファイルを正しい場所に配置できていることが確認できます。
+
+次に、ドキュメントでそれらの静的ファイルを使用するようにアプリを設定します。
+
+### 静的ファイル用に自動ドキュメントを無効化 { #disable-the-automatic-docs-for-static-files }
+
+カスタム CDN を使う場合と同様、最初の手順は自動ドキュメントを無効化することです。既定では CDN を使用します。
+
+無効化するには、`FastAPI` アプリ作成時にそれらの URL を `None` に設定します:
+
+{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[9] *}
+
+### 静的ファイル用のカスタムドキュメントを追加 { #include-the-custom-docs-for-static-files }
+
+カスタム CDN と同様の方法で、カスタムドキュメント用の *path operations* を作成できます。
+
+再び、FastAPI の内部関数を再利用してドキュメント用の HTML ページを生成し、必要な引数を渡します:
+
+- `openapi_url`: ドキュメントの HTML ページが API の OpenAPI スキーマを取得する URL。ここでは属性 `app.openapi_url` を使用できます。
+- `title`: API のタイトル。
+- `oauth2_redirect_url`: 既定値を使うにはここで `app.swagger_ui_oauth2_redirect_url` を使用できます。
+- `swagger_js_url`: Swagger UI ドキュメント用の HTML が取得する **JavaScript** ファイルの URL。**これはあなたのアプリ自身がいま配信しているものです**。
+- `swagger_css_url`: Swagger UI ドキュメント用の HTML が取得する **CSS** ファイルの URL。**これはあなたのアプリ自身がいま配信しているものです**。
+
+ReDoc についても同様です...
+
+{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[2:6,14:22,25:27,30:36] *}
+
+/// tip | 豆知識
+
+`swagger_ui_redirect` 用の *path operation* は、OAuth2 を使用する場合の補助です。
+
+API を OAuth2 プロバイダと統合すると、認証を実行して取得したクレデンシャルを持った状態で API ドキュメントに戻れます。そして実際の OAuth2 認証を用いてドキュメント上から API と対話できます。
+
+Swagger UI がこの処理を裏側で行いますが、そのためにこの「redirect」の補助が必要です。
+
+///
+
+### 静的ファイルをテストするための *path operation* を作成 { #create-a-path-operation-to-test-static-files }
+
+すべてが動作するかをテストできるように、*path operation* を作成します:
+
+{* ../../docs_src/custom_docs_ui/tutorial002_py310.py hl[39:41] *}
+
+### 静的ファイル UI のテスト { #test-static-files-ui }
+
+これで、WiFi を切断して http://127.0.0.1:8000/docs にアクセスし、ページを再読み込みできるはずです。
+
+インターネットに接続していなくても、API のドキュメントを表示し、API と対話できます。
diff --git a/docs/ja/docs/how-to/custom-request-and-route.md b/docs/ja/docs/how-to/custom-request-and-route.md
new file mode 100644
index 000000000..ae64f3109
--- /dev/null
+++ b/docs/ja/docs/how-to/custom-request-and-route.md
@@ -0,0 +1,109 @@
+# カスタム Request と APIRoute クラス { #custom-request-and-apiroute-class }
+
+場合によっては、`Request` や `APIRoute` クラスで使われるロジックを上書きしたいことがあります。
+
+特に、ミドルウェアでのロジックの代替として有効な場合があります。
+
+たとえば、アプリケーションで処理される前にリクエストボディを読み取ったり操作したりしたい場合です。
+
+/// danger | 警告
+
+これは「上級」機能です。
+
+FastAPI を始めたばかりの場合は、このセクションは読み飛ばしてもよいでしょう。
+
+///
+
+## ユースケース { #use-cases }
+
+ユースケースの例:
+
+* JSON ではないリクエストボディを JSON に変換する(例: `msgpack`)。
+* gzip 圧縮されたリクエストボディの解凍。
+* すべてのリクエストボディの自動ロギング。
+
+## カスタムリクエストボディのエンコーディングの処理 { #handling-custom-request-body-encodings }
+
+gzip のリクエストを解凍するために、カスタムの `Request` サブクラスを使う方法を見ていきます。
+
+そして、そのカスタムリクエストクラスを使うための `APIRoute` サブクラスを用意します。
+
+### カスタム `GzipRequest` クラスの作成 { #create-a-custom-gziprequest-class }
+
+/// tip | 豆知識
+
+これは仕組みを示すためのサンプルです。Gzip 対応が必要な場合は、用意されている [`GzipMiddleware`](../advanced/middleware.md#gzipmiddleware){.internal-link target=_blank} を使用できます。
+
+///
+
+まず、`GzipRequest` クラスを作成します。これは適切なヘッダーがある場合に本体を解凍するよう、`Request.body()` メソッドを上書きします。
+
+ヘッダーに `gzip` がなければ、解凍は試みません。
+
+この方法により、同じルートクラスで gzip 圧縮済み/未圧縮のリクエストの両方を扱えます。
+
+{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[9:16] *}
+
+### カスタム `GzipRoute` クラスの作成 { #create-a-custom-gziproute-class }
+
+次に、`GzipRequest` を利用する `fastapi.routing.APIRoute` のカスタムサブクラスを作成します。
+
+ここでは `APIRoute.get_route_handler()` メソッドを上書きします。
+
+このメソッドは関数を返します。そしてその関数がリクエストを受け取り、レスポンスを返します。
+
+ここでは、元のリクエストから `GzipRequest` を作成するために利用します。
+
+{* ../../docs_src/custom_request_and_route/tutorial001_an_py310.py hl[19:27] *}
+
+/// note | 技術詳細
+
+`Request` には `request.scope` 属性があり、これはリクエストに関するメタデータを含む Python の `dict` です。
+
+`Request` には `request.receive` もあり、これはリクエストの本体を「受信」するための関数です。
+
+`scope` の `dict` と `receive` 関数はいずれも ASGI 仕様の一部です。
+
+そしてこの 2 つ(`scope` と `receive`)が、新しい `Request` インスタンスを作成するために必要なものです。
+
+`Request` について詳しくは、Starlette の Requests に関するドキュメント を参照してください。
+
+///
+
+`GzipRequest.get_route_handler` が返す関数が異なるのは、`Request` を `GzipRequest` に変換する点だけです。
+
+これにより、`GzipRequest` は必要に応じてデータを解凍してから *path operations* に渡します。
+
+それ以降の処理ロジックはすべて同じです。
+
+ただし、`GzipRequest.body` を変更しているため、必要に応じて **FastAPI** によって読み込まれる際にリクエストボディが自動的に解凍されます。
+
+## 例外ハンドラでのリクエストボディへのアクセス { #accessing-the-request-body-in-an-exception-handler }
+
+/// tip | 豆知識
+
+同じ問題を解決するには、`RequestValidationError` 用のカスタムハンドラで `body` を使う方がずっと簡単でしょう([エラー処理](../tutorial/handling-errors.md#use-the-requestvalidationerror-body){.internal-link target=_blank})。
+
+ただし、この例も有効で、内部コンポーネントとどのようにやり取りするかを示しています。
+
+///
+
+同じアプローチを使って、例外ハンドラ内でリクエストボディにアクセスすることもできます。
+
+やることは、`try`/`except` ブロックの中でリクエストを処理するだけです:
+
+{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[14,16] *}
+
+例外が発生しても、`Request` インスタンスはスコープ内に残るため、エラー処理時にリクエストボディを読み取り、活用できます:
+
+{* ../../docs_src/custom_request_and_route/tutorial002_an_py310.py hl[17:19] *}
+
+## ルーターでのカスタム `APIRoute` クラス { #custom-apiroute-class-in-a-router }
+
+`APIRouter` の `route_class` パラメータを設定することもできます:
+
+{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[26] *}
+
+この例では、`router` 配下の *path operations* はカスタムの `TimedRoute` クラスを使用し、レスポンスの生成にかかった時間を示す追加の `X-Response-Time` ヘッダーがレスポンスに含まれます:
+
+{* ../../docs_src/custom_request_and_route/tutorial003_py310.py hl[13:20] *}
diff --git a/docs/ja/docs/how-to/extending-openapi.md b/docs/ja/docs/how-to/extending-openapi.md
new file mode 100644
index 000000000..df5b3cd35
--- /dev/null
+++ b/docs/ja/docs/how-to/extending-openapi.md
@@ -0,0 +1,80 @@
+# OpenAPI の拡張 { #extending-openapi }
+
+生成された OpenAPI スキーマを変更する必要がある場合があります。
+
+このセクションではその方法を説明します。
+
+## 通常のプロセス { #the-normal-process }
+
+通常(デフォルト)のプロセスは次のとおりです。
+
+`FastAPI` アプリケーション(インスタンス)には、OpenAPI スキーマを返すことが期待される `.openapi()` メソッドがあります。
+
+アプリケーションオブジェクトの作成時に、`/openapi.json`(または `openapi_url` に設定したパス)への path operation が登録されます。
+
+これは単に、アプリケーションの `.openapi()` メソッドの結果を含む JSON レスポンスを返します。
+
+デフォルトでは、`.openapi()` メソッドはプロパティ `.openapi_schema` に内容があるかを確認し、あればそれを返します。
+
+なければ、`fastapi.openapi.utils.get_openapi` にあるユーティリティ関数を使って生成します。
+
+この関数 `get_openapi()` は次の引数を受け取ります:
+
+- `title`: ドキュメントに表示される OpenAPI のタイトル。
+- `version`: API のバージョン。例: `2.5.0`。
+- `openapi_version`: 使用する OpenAPI 仕様のバージョン。デフォルトは最新の `3.1.0`。
+- `summary`: API の短い概要。
+- `description`: API の説明。Markdown を含めることができ、ドキュメントに表示されます。
+- `routes`: ルートのリスト。登録済みの各 path operation です。`app.routes` から取得されます。
+
+/// info | 情報
+
+パラメータ `summary` は OpenAPI 3.1.0 以降で利用可能で、FastAPI 0.99.0 以降が対応しています。
+
+///
+
+## デフォルトの上書き { #overriding-the-defaults }
+
+上記の情報を使って、同じユーティリティ関数で OpenAPI スキーマを生成し、必要な部分を上書きできます。
+
+たとえば、カスタムロゴを含めるための ReDoc の OpenAPI 拡張を追加してみましょう。
+
+### 通常の **FastAPI** { #normal-fastapi }
+
+まず、通常どおりに **FastAPI** アプリケーションを実装します:
+
+{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[1,4,7:9] *}
+
+### OpenAPI スキーマの生成 { #generate-the-openapi-schema }
+
+次に、`custom_openapi()` 関数内で同じユーティリティ関数を使って OpenAPI スキーマを生成します:
+
+{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[2,15:21] *}
+
+### OpenAPI スキーマの変更 { #modify-the-openapi-schema }
+
+OpenAPI スキーマの `info`「オブジェクト」にカスタムの `x-logo` を追加して、ReDoc 拡張を加えます:
+
+{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[22:24] *}
+
+### OpenAPI スキーマのキャッシュ { #cache-the-openapi-schema }
+
+生成したスキーマを保持する「キャッシュ」として `.openapi_schema` プロパティを利用できます。
+
+こうすることで、ユーザーが API ドキュメントを開くたびにスキーマを生成する必要がなくなります。
+
+最初の1回だけ生成され、その後は同じキャッシュ済みスキーマが以降のリクエストで使われます。
+
+{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[13:14,25:26] *}
+
+### メソッドの上書き { #override-the-method }
+
+これで、`.openapi()` メソッドを新しい関数に置き換えられます。
+
+{* ../../docs_src/extending_openapi/tutorial001_py310.py hl[29] *}
+
+### 確認 { #check-it }
+
+http://127.0.0.1:8000/redoc にアクセスすると、カスタムロゴ(この例では **FastAPI** のロゴ)が使われていることが確認できます:
+
+
diff --git a/docs/ja/docs/how-to/general.md b/docs/ja/docs/how-to/general.md
new file mode 100644
index 000000000..8879c68eb
--- /dev/null
+++ b/docs/ja/docs/how-to/general.md
@@ -0,0 +1,39 @@
+# 一般 - ハウツー - レシピ { #general-how-to-recipes }
+
+ここでは、一般的またはよくある質問に対して、ドキュメント内の他の箇所への参照をいくつか示します。
+
+## データのフィルタリング - セキュリティ { #filter-data-security }
+
+返すべき以上のデータを返さないようにするには、[チュートリアル - レスポンスモデル - 戻り値の型](../tutorial/response-model.md){.internal-link target=_blank} を参照してください。
+
+## ドキュメントのタグ - OpenAPI { #documentation-tags-openapi }
+
+*path operations* にタグを追加し、ドキュメント UI でグループ化するには、[チュートリアル - path operation の設定 - タグ](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank} を参照してください。
+
+## ドキュメントの概要と説明 - OpenAPI { #documentation-summary-and-description-openapi }
+
+*path operations* に概要と説明を追加し、ドキュメント UI に表示するには、[チュートリアル - path operation の設定 - 概要と説明](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank} を参照してください。
+
+## ドキュメントのレスポンス説明 - OpenAPI { #documentation-response-description-openapi }
+
+ドキュメント UI に表示されるレスポンスの説明を定義するには、[チュートリアル - path operation の設定 - レスポンスの説明](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank} を参照してください。
+
+## *Path Operation* の非推奨化 - OpenAPI { #documentation-deprecate-a-path-operation-openapi }
+
+*path operation* を非推奨にし、ドキュメント UI に表示するには、[チュートリアル - path operation の設定 - 非推奨](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank} を参照してください。
+
+## 任意のデータを JSON 互換に変換 { #convert-any-data-to-json-compatible }
+
+任意のデータを JSON 互換に変換するには、[チュートリアル - JSON 互換エンコーダ](../tutorial/encoder.md){.internal-link target=_blank} を参照してください。
+
+## OpenAPI メタデータ - ドキュメント { #openapi-metadata-docs }
+
+ライセンス、バージョン、連絡先などを含むメタデータを OpenAPI スキーマに追加するには、[チュートリアル - メタデータとドキュメントの URL](../tutorial/metadata.md){.internal-link target=_blank} を参照してください。
+
+## OpenAPI のカスタム URL { #openapi-custom-url }
+
+OpenAPI の URL をカスタマイズ(または削除)するには、[チュートリアル - メタデータとドキュメントの URL](../tutorial/metadata.md#openapi-url){.internal-link target=_blank} を参照してください。
+
+## OpenAPI ドキュメントの URL { #openapi-docs-urls }
+
+自動生成されるドキュメント UI が使用する URL を変更するには、[チュートリアル - メタデータとドキュメントの URL](../tutorial/metadata.md#docs-urls){.internal-link target=_blank} を参照してください。
diff --git a/docs/ja/docs/how-to/graphql.md b/docs/ja/docs/how-to/graphql.md
new file mode 100644
index 000000000..bd0d22349
--- /dev/null
+++ b/docs/ja/docs/how-to/graphql.md
@@ -0,0 +1,60 @@
+# GraphQL { #graphql }
+
+**FastAPI** は **ASGI** 標準に基づいているため、ASGI に対応した任意の **GraphQL** ライブラリを簡単に統合できます。
+
+同じアプリケーション内で通常の FastAPI の *path operation* と GraphQL を組み合わせて使えます。
+
+/// tip | 豆知識
+
+**GraphQL** は非常に特定のユースケースを解決します。
+
+一般的な **Web API** と比べると、**長所** と **短所** があります。
+
+ご自身のユースケースで得られる **利点** が **欠点** を補うかどうかを評価してください。 🤓
+
+///
+
+## GraphQL ライブラリ { #graphql-libraries }
+
+**ASGI** をサポートする **GraphQL** ライブラリの一部を以下に示します。**FastAPI** と組み合わせて使用できます:
+
+* Strawberry 🍓
+ * FastAPI 向けドキュメントあり
+* Ariadne
+ * FastAPI 向けドキュメントあり
+* Tartiflette
+ * ASGI 連携用の Tartiflette ASGI あり
+* Graphene
+ * starlette-graphene3 あり
+
+## Strawberry で GraphQL { #graphql-with-strawberry }
+
+**GraphQL** が必要、または利用したい場合は、**Strawberry** を**推奨**します。**FastAPI** の設計に最も近く、すべてが**型アノテーション**に基づいています。
+
+ユースケースによっては他のライブラリを選ぶ方がよい場合もありますが、私に尋ねられれば、おそらく **Strawberry** を試すことを勧めるでしょう。
+
+FastAPI と Strawberry を統合する方法の簡単なプレビューです:
+
+{* ../../docs_src/graphql_/tutorial001_py310.py hl[3,22,25] *}
+
+詳細は Strawberry のドキュメントをご覧ください。
+
+また、Strawberry と FastAPI の連携に関するドキュメントもあります。
+
+## Starlette の旧 `GraphQLApp` { #older-graphqlapp-from-starlette }
+
+以前の Starlette には、Graphene と統合するための `GraphQLApp` クラスが含まれていました。
+
+これは Starlette からは非推奨になりましたが、もしそれを使用しているコードがある場合は、同じユースケースをカバーし、**ほぼ同一のインターフェース**を持つ starlette-graphene3 へ容易に**移行**できます。
+
+/// tip | 豆知識
+
+GraphQL が必要であれば、依然として Strawberry の利用を推奨します。独自のクラスや型ではなく、型アノテーションに基づいているためです。
+
+///
+
+## さらに学ぶ { #learn-more }
+
+**GraphQL** については、公式 GraphQL ドキュメントでさらに学べます。
+
+上記の各ライブラリについては、リンク先のドキュメントをご参照ください。
diff --git a/docs/ja/docs/how-to/index.md b/docs/ja/docs/how-to/index.md
new file mode 100644
index 000000000..b1cd17785
--- /dev/null
+++ b/docs/ja/docs/how-to/index.md
@@ -0,0 +1,13 @@
+# ハウツー - レシピ { #how-to-recipes }
+
+ここでは、**複数のトピック**に関するさまざまなレシピや「ハウツー」ガイドを紹介します。
+
+これらのアイデアの多くはおおむね**独立**しており、ほとんどの場合、**あなたのプロジェクト**に直接当てはまるものだけを読めば十分です。
+
+プロジェクトにとって興味深く有用だと思うものがあれば、ぜひ確認してください。そうでなければ、読み飛ばしても問題ありません。
+
+/// tip | 豆知識
+
+**FastAPI を学ぶ**ことを体系的に進めたい場合(推奨)、代わりに [チュートリアル - ユーザーガイド](../tutorial/index.md){.internal-link target=_blank} を章ごとに読んでください。
+
+///
diff --git a/docs/ja/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md b/docs/ja/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md
new file mode 100644
index 000000000..f1414ac28
--- /dev/null
+++ b/docs/ja/docs/how-to/migrate-from-pydantic-v1-to-pydantic-v2.md
@@ -0,0 +1,135 @@
+# Pydantic v1 から Pydantic v2 への移行 { #migrate-from-pydantic-v1-to-pydantic-v2 }
+
+古い FastAPI アプリがある場合、Pydantic v1 を使っているかもしれません。
+
+FastAPI 0.100.0 は Pydantic v1 / v2 のどちらにも対応しており、インストールされている方を使用しました。
+
+FastAPI 0.119.0 では、Pydantic v2 内からの Pydantic v1 の部分的サポート(`pydantic.v1`)が導入され、v2 への移行が容易になりました。
+
+FastAPI 0.126.0 で Pydantic v1 のサポートは終了しましたが、しばらくの間は `pydantic.v1` は利用可能でした。
+
+/// warning | 注意
+
+Pydantic チームは Python の最新バージョン、つまり **Python 3.14** から、Pydantic v1 のサポートを終了しました。
+
+これには `pydantic.v1` も含まれ、Python 3.14 以上ではサポートされません。
+
+Python の最新機能を使いたい場合は、Pydantic v2 を使用していることを確認する必要があります。
+
+///
+
+古い FastAPI アプリで Pydantic v1 を使っている場合、ここでは Pydantic v2 への移行方法と、段階的移行を助ける **FastAPI 0.119.0 の機能** を紹介します。
+
+## 公式ガイド { #official-guide }
+
+Pydantic には v1 から v2 への公式の 移行ガイド があります。
+
+変更点、検証がより正確で厳密になった点、注意事項などが含まれます。
+
+何が変わったかをよりよく理解するために参照してください。
+
+## テスト { #tests }
+
+アプリに対する[テスト](../tutorial/testing.md){.internal-link target=_blank}を用意し、継続的インテグレーション(CI)で実行するようにしてください。
+
+これにより、アップグレード後も期待どおり動作していることを確認できます。
+
+## `bump-pydantic` { #bump-pydantic }
+
+多くの場合、カスタマイズのない通常の Pydantic モデルを使っていれば、v1 から v2 への移行作業の大半を自動化できます。
+
+同じ Pydantic チームが提供する `bump-pydantic` を使用できます。
+
+このツールは必要なコード変更のほとんどを自動で行います。
+
+その後テストを実行し、問題なければ完了です。😎
+
+## v2 における Pydantic v1 { #pydantic-v1-in-v2 }
+
+Pydantic v2 には、Pydantic v1 がサブモジュール `pydantic.v1` として同梱されています。ただし、これは Python 3.13 を超えるバージョンではサポートされません。
+
+つまり、Pydantic v2 の最新バージョンをインストールし、このサブモジュールから旧 Pydantic v1 のコンポーネントをインポートして、あたかも v1 をインストールしているかのように使用できます。
+
+{* ../../docs_src/pydantic_v1_in_v2/tutorial001_an_py310.py hl[1,4] *}
+
+### v2 内の Pydantic v1 に対する FastAPI のサポート { #fastapi-support-for-pydantic-v1-in-v2 }
+
+FastAPI 0.119.0 以降では、移行を容易にするため、Pydantic v2 内の Pydantic v1 に対する部分的サポートもあります。
+
+そのため、Pydantic を v2 の最新に上げ、インポートを `pydantic.v1` サブモジュールに切り替えるだけで、多くの場合そのまま動作します。
+
+{* ../../docs_src/pydantic_v1_in_v2/tutorial002_an_py310.py hl[2,5,15] *}
+
+/// warning | 注意
+
+前述のとおり、Python の最近のバージョン(Python 3.14 以降)では Pydantic v1 がサポートされないため、`pydantic.v1` の使用も Python 3.14 以上ではサポートされません。
+
+///
+
+### 同一アプリでの Pydantic v1 と v2 { #pydantic-v1-and-v2-on-the-same-app }
+
+Pydantic v2 のモデルのフィールドに Pydantic v1 のモデルを(またはその逆を)埋め込むことは、Pydantic では「サポートされていません」。
+
+```mermaid
+graph TB
+ subgraph "❌ Not Supported"
+ direction TB
+ subgraph V2["Pydantic v2 Model"]
+ V1Field["Pydantic v1 Model"]
+ end
+ subgraph V1["Pydantic v1 Model"]
+ V2Field["Pydantic v2 Model"]
+ end
+ end
+
+ style V2 fill:#f9fff3
+ style V1 fill:#fff6f0
+ style V1Field fill:#fff6f0
+ style V2Field fill:#f9fff3
+```
+
+...but, you can have separated models using Pydantic v1 and v2 in the same app.
+
+```mermaid
+graph TB
+ subgraph "✅ Supported"
+ direction TB
+ subgraph V2["Pydantic v2 Model"]
+ V2Field["Pydantic v2 Model"]
+ end
+ subgraph V1["Pydantic v1 Model"]
+ V1Field["Pydantic v1 Model"]
+ end
+ end
+
+ style V2 fill:#f9fff3
+ style V1 fill:#fff6f0
+ style V1Field fill:#fff6f0
+ style V2Field fill:#f9fff3
+```
+
+場合によっては、同じ FastAPI の path operation 内で、Pydantic v1 と v2 の両方のモデルを扱うことも可能です:
+
+{* ../../docs_src/pydantic_v1_in_v2/tutorial003_an_py310.py hl[2:3,6,12,21:22] *}
+
+上の例では、入力モデルは Pydantic v1、出力モデル(`response_model=ItemV2` で定義)は Pydantic v2 です。
+
+### Pydantic v1 のパラメータ { #pydantic-v1-parameters }
+
+Pydantic v1 のモデルで `Body`、`Query`、`Form` などの FastAPI 固有のパラメータユーティリティを使う必要がある場合、v2 への移行が完了するまでの間は `fastapi.temp_pydantic_v1_params` からインポートできます:
+
+{* ../../docs_src/pydantic_v1_in_v2/tutorial004_an_py310.py hl[4,18] *}
+
+### 段階的に移行 { #migrate-in-steps }
+
+/// tip | 豆知識
+
+まずは `bump-pydantic` を試してください。テストが通り、問題なければコマンド一発で完了です。✨
+
+///
+
+`bump-pydantic` が適用できない場合は、同一アプリで v1 と v2 のモデルを併用できるサポートを利用して、徐々に v2 へ移行できます。
+
+まず Pydantic を v2 の最新にアップグレードし、すべてのモデルのインポートを `pydantic.v1` に切り替えます。
+
+その後、モデルをグループごとに少しずつ Pydantic v1 から v2 へ移行していきます。🚶
diff --git a/docs/ja/docs/how-to/separate-openapi-schemas.md b/docs/ja/docs/how-to/separate-openapi-schemas.md
new file mode 100644
index 000000000..46df2aafb
--- /dev/null
+++ b/docs/ja/docs/how-to/separate-openapi-schemas.md
@@ -0,0 +1,102 @@
+# 入力と出力でOpenAPIのスキーマを分けるかどうか { #separate-openapi-schemas-for-input-and-output-or-not }
+
+**Pydantic v2** のリリース以降、生成される OpenAPI は以前より少し正確で、より正しいものになりました。😎
+
+実際には、場合によっては同じ Pydantic モデルに対して、入力用と出力用で OpenAPI に **2 つの JSON Schema** が含まれることがあります。これは **デフォルト値** の有無に依存します。
+
+その動作と、必要に応じての変更方法を見ていきます。
+
+## 入出力のPydanticモデル { #pydantic-models-for-input-and-output }
+
+次のようにデフォルト値を持つ Pydantic モデルがあるとします。
+
+{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:7] hl[7] *}
+
+### 入力用モデル { #model-for-input }
+
+このモデルを次のように入力として使うと:
+
+{* ../../docs_src/separate_openapi_schemas/tutorial001_py310.py ln[1:15] hl[14] *}
+
+...`description` フィールドは **必須ではありません**。デフォルト値が `None` だからです。
+
+### ドキュメントでの入力モデル { #input-model-in-docs }
+
+ドキュメントで確認すると、`description` フィールドには **赤いアスタリスク** が付いておらず、必須としてはマークされていません:
+
+
+
+
+
+
+httpx - `TestClient` を使用したい場合に必要です。
* jinja2 - デフォルトのテンプレート設定を使用したい場合に必要です。
-* python-multipart - `request.form()` とともに、フォームの 「parsing」 をサポートしたい場合に必要です。
+* python-multipart - `request.form()` とともに、フォームの 「parsing」 をサポートしたい場合に必要です。
FastAPI によって使用されるもの:
diff --git a/docs/ja/docs/python-types.md b/docs/ja/docs/python-types.md
index 26a9e2193..a6b46c256 100644
--- a/docs/ja/docs/python-types.md
+++ b/docs/ja/docs/python-types.md
@@ -1,12 +1,12 @@
# Pythonの型の紹介 { #python-types-intro }
-Pythonではオプションの「型ヒント」(「型アノテーション」とも呼ばれます)がサポートされています。
+Python にはオプションの「型ヒント」(「型アノテーション」とも呼ばれます)がサポートされています。
-これらの **「型ヒント」** またはアノテーションは、変数の型を宣言できる特別な構文です。
+これらの **「型ヒント」** やアノテーションは、変数の型を宣言できる特別な構文です。
変数に型を宣言することで、エディターやツールがより良いサポートを提供できます。
-これはPythonの型ヒントについての **クイックチュートリアル/リフレッシュ** にすぎません。**FastAPI** で使用するために必要な最低限のことだけをカバーしています。...実際には本当に少ないです。
+これは Python の型ヒントについての **クイックチュートリアル/リフレッシュ** にすぎません。**FastAPI** で使うために必要な最低限のことだけをカバーしています。...実際には本当に少ないです。
**FastAPI** はすべてこれらの型ヒントに基づいており、多くの強みと利点を与えてくれます。
@@ -14,7 +14,7 @@ Pythonではオプションの「型ヒント」(「型アノテーション
/// note | 備考
-もしあなたがPythonの専門家で、すでに型ヒントについてすべて知っているのであれば、次の章まで読み飛ばしてください。
+もしあなたが Python の専門家で、すでに型ヒントについてすべて知っているのであれば、次の章まで読み飛ばしてください。
///
@@ -22,7 +22,7 @@ Pythonではオプションの「型ヒント」(「型アノテーション
簡単な例から始めてみましょう:
-{* ../../docs_src/python_types/tutorial001_py39.py *}
+{* ../../docs_src/python_types/tutorial001_py310.py *}
このプログラムを呼び出すと、以下が出力されます:
@@ -32,11 +32,11 @@ John Doe
この関数は以下のようなことを行います:
-* `first_name`と`last_name`を取得します。
-* `title()`を用いて、それぞれの最初の文字を大文字に変換します。
-* 真ん中にスペースを入れて連結します。
+* `first_name` と `last_name` を取得します。
+* `title()` を用いて、それぞれの最初の文字を大文字に変換します。
+* 真ん中にスペースを入れて連結します。
-{* ../../docs_src/python_types/tutorial001_py39.py hl[2] *}
+{* ../../docs_src/python_types/tutorial001_py310.py hl[2] *}
### 編集 { #edit-it }
@@ -48,11 +48,11 @@ John Doe
しかし、そうすると「最初の文字を大文字に変換するあのメソッド」を呼び出す必要があります。
-それは`upper`でしたか?`uppercase`でしたか?`first_uppercase`?`capitalize`?
+それは `upper` でしたか?`uppercase` でしたか?`first_uppercase`?`capitalize`?
そして、古くからプログラマーの友人であるエディタで自動補完を試してみます。
-関数の最初のパラメータ`first_name`を入力し、ドット(`.`)を入力してから、`Ctrl+Space`を押すと補完が実行されます。
+関数の最初のパラメータ `first_name` を入力し、ドット(`.`)を入力してから、`Ctrl+Space` を押すと補完が実行されます。
しかし、悲しいことに、これはなんの役にも立ちません:
@@ -78,7 +78,7 @@ John Doe
それが「型ヒント」です:
-{* ../../docs_src/python_types/tutorial002_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial002_py310.py hl[1] *}
これは、以下のようにデフォルト値を宣言するのと同じではありません:
@@ -94,7 +94,7 @@ John Doe
しかし今、あなたが再びその関数を作成している最中に、型ヒントを使っていると想像してみてください。
-同じタイミングで`Ctrl+Space`で自動補完を実行すると、以下のようになります:
+同じタイミングで `Ctrl+Space` で自動補完を実行すると、以下のようになります:
@@ -106,15 +106,15 @@ John Doe
この関数を見てください。すでに型ヒントを持っています:
-{* ../../docs_src/python_types/tutorial003_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial003_py310.py hl[1] *}
エディタは変数の型を知っているので、補完だけでなく、エラーチェックをすることもできます:
-これで`age`を`str(age)`で文字列に変換して修正する必要があることがわかります:
+これで `age` を `str(age)` で文字列に変換して修正する必要があることがわかります:
-{* ../../docs_src/python_types/tutorial004_py39.py hl[2] *}
+{* ../../docs_src/python_types/tutorial004_py310.py hl[2] *}
## 型の宣言 { #declaring-types }
@@ -124,7 +124,7 @@ John Doe
### 単純な型 { #simple-types }
-`str`だけでなく、Pythonの標準的な型すべてを宣言できます。
+`str` だけでなく、Python の標準的な型すべてを宣言できます。
例えば、以下を使用可能です:
@@ -133,51 +133,54 @@ John Doe
* `bool`
* `bytes`
-{* ../../docs_src/python_types/tutorial005_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial005_py310.py hl[1] *}
-### 型パラメータを持つジェネリック型 { #generic-types-with-type-parameters }
+### `typing` モジュール { #typing-module }
-データ構造の中には、`dict`、`list`、`set`、`tuple`のように他の値を含むことができるものがあります。また内部の値も独自の型を持つことができます。
+いくつかの追加のユースケースでは、標準ライブラリの `typing` モジュールから何かをインポートする必要があるかもしれません。例えば「任意の型」を受け付けることを宣言したい場合、`typing` の `Any` を使えます:
-内部の型を持つこれらの型は「**generic**」型と呼ばれます。そして、内部の型も含めて宣言することが可能です。
+```python
+from typing import Any
-これらの型や内部の型を宣言するには、Pythonの標準モジュール`typing`を使用できます。これらの型ヒントをサポートするために特別に存在しています。
-#### 新しいPythonバージョン { #newer-versions-of-python }
+def some_function(data: Any):
+ print(data)
+```
-`typing`を使う構文は、Python 3.6から最新バージョンまで(Python 3.9、Python 3.10などを含む)すべてのバージョンと **互換性** があります。
+### ジェネリック型 { #generic-types }
-Pythonが進化するにつれ、**新しいバージョン** ではこれらの型アノテーションへのサポートが改善され、多くの場合、型アノテーションを宣言するために`typing`モジュールをインポートして使う必要すらなくなります。
+一部の型は、角括弧内で「型パラメータ」を受け取り、内部の型を定義できます。例えば「文字列のリスト」は `list[str]` として宣言します。
-プロジェクトでより新しいPythonバージョンを選べるなら、その追加のシンプルさを活用できます。
+このように型パラメータを取れる型は **Generic types**(ジェネリクス)と呼ばれます。
-ドキュメント全体で、Pythonの各バージョンと互換性のある例(差分がある場合)を示しています。
+次の組み込み型をジェネリクスとして(角括弧と内部の型で)使えます:
-例えば「**Python 3.6+**」はPython 3.6以上(3.7、3.8、3.9、3.10などを含む)と互換性があることを意味します。また「**Python 3.9+**」はPython 3.9以上(3.10などを含む)と互換性があることを意味します。
-
-**最新のPythonバージョン** を使えるなら、最新バージョン向けの例を使ってください。例えば「**Python 3.10+**」のように、それらは **最良かつ最もシンプルな構文** になります。
+* `list`
+* `tuple`
+* `set`
+* `dict`
#### List { #list }
-例えば、`str`の`list`の変数を定義してみましょう。
+例えば、`str` の `list` の変数を定義してみましょう。
同じコロン(`:`)の構文で変数を宣言します。
-型として、`list`を指定します。
+型として、`list` を指定します。
リストはいくつかの内部の型を含む型なので、それらを角括弧で囲みます:
-{* ../../docs_src/python_types/tutorial006_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial006_py310.py hl[1] *}
/// info | 情報
角括弧内の内部の型は「型パラメータ」と呼ばれています。
-この場合、`str`は`list`に渡される型パラメータです。
+この場合、`str` は `list` に渡される型パラメータです。
///
-つまり: 変数`items`は`list`であり、このリストの各項目は`str`です。
+つまり: 変数 `items` は `list` であり、このリストの各項目は `str` です。
そうすることで、エディタはリストの項目を処理している間にもサポートを提供できます。
@@ -185,78 +188,54 @@ Pythonが進化するにつれ、**新しいバージョン** ではこれらの
型がなければ、それはほぼ不可能です。
-変数`item`はリスト`items`の要素の一つであることに注意してください。
+変数 `item` はリスト `items` の要素の一つであることに注意してください。
-それでも、エディタはそれが`str`であることを知っていて、そのためのサポートを提供しています。
+それでも、エディタはそれが `str` であることを知っていて、そのためのサポートを提供しています。
#### Tuple と Set { #tuple-and-set }
-`tuple`と`set`の宣言も同様です:
+`tuple` と `set` の宣言も同様です:
-{* ../../docs_src/python_types/tutorial007_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial007_py310.py hl[1] *}
つまり:
-* 変数`items_t`は`int`、別の`int`、`str`の3つの項目を持つ`tuple`です。
-* 変数`items_s`は`set`であり、その各項目は`bytes`型です。
+* 変数 `items_t` は `int`、別の `int`、`str` の 3 つの項目を持つ `tuple` です。
+* 変数 `items_s` は `set` であり、その各項目は `bytes` 型です。
#### Dict { #dict }
-`dict`を定義するには、カンマ区切りで2つの型パラメータを渡します。
+`dict` を定義するには、カンマ区切りで 2 つの型パラメータを渡します。
-最初の型パラメータは`dict`のキーです。
+最初の型パラメータは `dict` のキーです。
-2番目の型パラメータは`dict`の値です:
+2 番目の型パラメータは `dict` の値です:
-{* ../../docs_src/python_types/tutorial008_py39.py hl[1] *}
+{* ../../docs_src/python_types/tutorial008_py310.py hl[1] *}
つまり:
-* 変数`prices`は`dict`です:
- * この`dict`のキーは`str`型です(例えば、各項目の名前)。
- * この`dict`の値は`float`型です(例えば、各項目の価格)。
+* 変数 `prices` は `dict` です:
+ * この `dict` のキーは `str` 型です(例えば、各項目の名前)。
+ * この `dict` の値は `float` 型です(例えば、各項目の価格)。
#### Union { #union }
-変数が**複数の型のいずれか**になり得ることを宣言できます。例えば、`int`または`str`です。
+変数が **複数の型のいずれか** になり得ることを宣言できます。例えば、`int` または `str` です。
-Python 3.6以上(Python 3.10を含む)では、`typing`の`Union`型を使い、角括弧の中に受け付ける可能性のある型を入れられます。
+それを定義するには、両方の型を区切るために 縦棒(`|`) を使います。
-Python 3.10では、受け付ける可能性のある型を縦棒(`|`)で区切って書ける **新しい構文** もあります。
-
-//// tab | Python 3.10+
+これは「ユニオン(union)」と呼ばれます。変数がそれら 2 つの型の集合の和集合のいずれかになり得るからです。
```Python hl_lines="1"
{!> ../../docs_src/python_types/tutorial008b_py310.py!}
```
-////
+これは `item` が `int` または `str` になり得ることを意味します.
-//// tab | Python 3.9+
+#### `None` の可能性 { #possibly-none }
-```Python hl_lines="1 4"
-{!> ../../docs_src/python_types/tutorial008b_py39.py!}
-```
-
-////
-
-どちらの場合も、`item`は`int`または`str`になり得ることを意味します。
-
-#### `None`の可能性 { #possibly-none }
-
-値が`str`のような型を持つ可能性がある一方で、`None`にもなり得ることを宣言できます。
-
-Python 3.6以上(Python 3.10を含む)では、`typing`モジュールから`Optional`をインポートして使うことで宣言できます。
-
-```Python hl_lines="1 4"
-{!../../docs_src/python_types/tutorial009_py39.py!}
-```
-
-ただの`str`の代わりに`Optional[str]`を使用することで、値が常に`str`であると仮定しているときに、実際には`None`である可能性もあるというエラーをエディタが検出するのに役立ちます。
-
-`Optional[Something]`は実際には`Union[Something, None]`のショートカットで、両者は等価です。
-
-これは、Python 3.10では`Something | None`も使えることを意味します:
+値が `str` のような型を持つ可能性がある一方で、`None` にもなり得ることを宣言できます。
//// tab | Python 3.10+
@@ -266,120 +245,31 @@ Python 3.6以上(Python 3.10を含む)では、`typing`モジュールから
////
-//// tab | Python 3.9+
-
-```Python hl_lines="1 4"
-{!> ../../docs_src/python_types/tutorial009_py39.py!}
-```
-
-////
-
-//// tab | Python 3.9+ alternative
-
-```Python hl_lines="1 4"
-{!> ../../docs_src/python_types/tutorial009b_py39.py!}
-```
-
-////
-
-#### `Union`または`Optional`の使用 { #using-union-or-optional }
-
-Python 3.10未満のバージョンを使っている場合、これは私のとても **主観的** な観点からのヒントです:
-
-* 🚨 `Optional[SomeType]`は避けてください
-* 代わりに ✨ **`Union[SomeType, None]`を使ってください** ✨
-
-どちらも等価で、内部的には同じですが、`Optional`より`Union`をおすすめします。というのも「**optional**」という単語は値がオプションであることを示唆するように見えますが、実際には「`None`になり得る」という意味であり、オプションではなく必須である場合でもそうだからです。
-
-`Union[SomeType, None]`のほうが意味がより明示的だと思います。
-
-これは言葉や名前の話にすぎません。しかし、その言葉はあなたやチームメイトがコードをどう考えるかに影響し得ます。
-
-例として、この関数を見てみましょう:
-
-{* ../../docs_src/python_types/tutorial009c_py39.py hl[1,4] *}
-
-パラメータ`name`は`Optional[str]`として定義されていますが、**オプションではありません**。そのパラメータなしで関数を呼び出せません:
-
-```Python
-say_hi() # Oh, no, this throws an error! 😱
-```
-
-`name`パラメータはデフォルト値がないため、**依然として必須**(*optional*ではない)です。それでも、`name`は値として`None`を受け付けます:
-
-```Python
-say_hi(name=None) # This works, None is valid 🎉
-```
-
-良い知らせとして、Python 3.10になればその心配は不要です。型のユニオンを定義するために`|`を単純に使えるからです:
-
-{* ../../docs_src/python_types/tutorial009c_py310.py hl[1,4] *}
-
-そして、`Optional`や`Union`のような名前について心配する必要もなくなります。😎
-
-#### ジェネリック型 { #generic-types }
-
-角括弧で型パラメータを取るこれらの型は、例えば次のように **Generic types** または **Generics** と呼ばれます:
-
-//// tab | Python 3.10+
-
-同じ組み込み型をジェネリクスとして(角括弧と内部の型で)使えます:
-
-* `list`
-* `tuple`
-* `set`
-* `dict`
-
-また、これまでのPythonバージョンと同様に、`typing`モジュールから:
-
-* `Union`
-* `Optional`
-* ...and others.
-
-Python 3.10では、ジェネリクスの`Union`や`Optional`を使う代替として、型のユニオンを宣言するために縦棒(`|`)を使えます。これはずっと良く、よりシンプルです。
-
-////
-
-//// tab | Python 3.9+
-
-同じ組み込み型をジェネリクスとして(角括弧と内部の型で)使えます:
-
-* `list`
-* `tuple`
-* `set`
-* `dict`
-
-そして`typing`モジュールのジェネリクス:
-
-* `Union`
-* `Optional`
-* ...and others.
-
-////
+ただの `str` の代わりに `str | None` を使用することで、値が常に `str` であると仮定しているときに、実際には `None` である可能性もあるというエラーをエディタが検出するのに役立ちます。
### 型としてのクラス { #classes-as-types }
変数の型としてクラスを宣言することもできます。
-名前を持つ`Person`クラスがあるとしましょう:
+名前を持つ `Person` クラスがあるとしましょう:
-{* ../../docs_src/python_types/tutorial010_py39.py hl[1:3] *}
+{* ../../docs_src/python_types/tutorial010_py310.py hl[1:3] *}
-変数を`Person`型として宣言できます:
+変数を `Person` 型として宣言できます:
-{* ../../docs_src/python_types/tutorial010_py39.py hl[6] *}
+{* ../../docs_src/python_types/tutorial010_py310.py hl[6] *}
そして、再び、すべてのエディタのサポートを得ることができます:
-これは「`one_person`はクラス`Person`の**インスタンス**である」ことを意味します。
+これは「`one_person` はクラス `Person` の **インスタンス** である」ことを意味します。
-「`one_person`は`Person`という名前の**クラス**である」という意味ではありません。
+「`one_person` は `Person` という名前の **クラス** である」という意味ではありません。
-## Pydanticのモデル { #pydantic-models }
+## Pydantic のモデル { #pydantic-models }
-Pydantic はデータ検証を行うためのPythonライブラリです。
+Pydantic はデータ検証を行うための Python ライブラリです。
データの「形」を属性付きのクラスとして宣言します。
@@ -389,53 +279,47 @@ Python 3.10では、ジェネリクスの`Union`や`Optional`を使う代替と
また、その結果のオブジェクトですべてのエディタのサポートを受けることができます。
-Pydanticの公式ドキュメントからの例:
+Pydantic の公式ドキュメントからの例:
{* ../../docs_src/python_types/tutorial011_py310.py *}
/// info | 情報
-Pydanticの詳細はドキュメントを参照してください。
+Pydantic の詳細はドキュメントを参照してください。
///
-**FastAPI** はすべてPydanticをベースにしています。
+**FastAPI** はすべて Pydantic をベースにしています。
-すべてのことは[チュートリアル - ユーザーガイド](tutorial/index.md){.internal-link target=_blank}で実際に見ることができます。
-
-/// tip | 豆知識
-
-Pydanticには、デフォルト値なしで`Optional`または`Union[Something, None]`を使った場合の特別な挙動があります。詳細はPydanticドキュメントのRequired Optional fieldsを参照してください。
-
-///
+すべてのことは [チュートリアル - ユーザーガイド](tutorial/index.md){.internal-link target=_blank} で実際に見ることができます。
## メタデータアノテーション付き型ヒント { #type-hints-with-metadata-annotations }
-Pythonには、`Annotated`を使って型ヒントに**追加のメタデータ**を付与できる機能もあります。
+Python には、`Annotated` を使って型ヒントに **追加の メタデータ** を付与できる機能もあります。
-Python 3.9以降、`Annotated`は標準ライブラリの一部なので、`typing`からインポートできます。
+`Annotated` は `typing` からインポートできます。
-{* ../../docs_src/python_types/tutorial013_py39.py hl[1,4] *}
+{* ../../docs_src/python_types/tutorial013_py310.py hl[1,4] *}
-Python自体は、この`Annotated`で何かをするわけではありません。また、エディタや他のツールにとっても、型は依然として`str`です。
+Python 自体は、この `Annotated` で何かをするわけではありません。また、エディタや他のツールにとっても、型は依然として `str` です。
-しかし、`Annotated`内のこのスペースを使って、アプリケーションをどのように動作させたいかについての追加メタデータを **FastAPI** に提供できます。
+しかし、`Annotated` 内のこのスペースを使って、アプリケーションをどのように動作させたいかについての追加メタデータを **FastAPI** に提供できます。
-覚えておくべき重要な点は、`Annotated`に渡す**最初の*型パラメータ***が**実際の型**であることです。残りは、他のツール向けのメタデータにすぎません。
+覚えておくべき重要な点は、`Annotated` に渡す **最初の「型パラメータ」** が **実際の型** であることです。残りは、他のツール向けのメタデータにすぎません。
-今のところは、`Annotated`が存在し、それが標準のPythonであることを知っておけば十分です。😎
+今のところは、`Annotated` が存在し、それが標準の Python であることを知っておけば十分です。😎
-後で、これがどれほど**強力**になり得るかを見ることになります。
+後で、これがどれほど **強力** になり得るかを見ることになります。
/// tip | 豆知識
-これが **標準のPython** であるという事実は、エディタで、使用しているツール(コードの解析やリファクタリングなど)とともに、**可能な限り最高の開発体験**が得られることを意味します。 ✨
+これが **標準の Python** であるという事実は、エディタで、使用しているツール(コードの解析やリファクタリングなど)とともに、**可能な限り最高の開発体験** が得られることを意味します。 ✨
-また、あなたのコードが他の多くのPythonツールやライブラリとも非常に互換性が高いことも意味します。 🚀
+また、あなたのコードが他の多くの Python ツールやライブラリとも非常に互換性が高いことも意味します。 🚀
///
-## **FastAPI**での型ヒント { #type-hints-in-fastapi }
+## **FastAPI** での型ヒント { #type-hints-in-fastapi }
**FastAPI** はこれらの型ヒントを利用していくつかのことを行います。
@@ -450,15 +334,15 @@ Python自体は、この`Annotated`で何かをするわけではありません
* **データの変換**: リクエストから必要な型にデータを変換します。
* **データの検証**: 各リクエストから来るデータについて:
* データが無効な場合にクライアントに返される **自動エラー** を生成します。
-* OpenAPIを使用してAPIを**ドキュメント化**します:
+* OpenAPI を使用して API を **ドキュメント化** します:
* これは自動の対話型ドキュメントのユーザーインターフェイスで使われます。
-すべてが抽象的に聞こえるかもしれません。心配しないでください。 この全ての動作は [チュートリアル - ユーザーガイド](tutorial/index.md){.internal-link target=_blank}で見ることができます。
+すべてが抽象的に聞こえるかもしれません。心配しないでください。 この全ての動作は [チュートリアル - ユーザーガイド](tutorial/index.md){.internal-link target=_blank} で見ることができます。
-重要なのは、Pythonの標準的な型を使うことで、(クラスやデコレータなどを追加するのではなく)1つの場所で **FastAPI** が多くの作業を代わりにやってくれているということです。
+重要なのは、Python の標準的な型を使うことで、(クラスやデコレータなどを追加するのではなく)1 つの場所で **FastAPI** が多くの作業を代わりにやってくれているということです。
/// info | 情報
-すでにすべてのチュートリアルを終えて、型についての詳細を見るためにこのページに戻ってきた場合は、良いリソースとして`mypy`の「チートシート」があります。
+すでにすべてのチュートリアルを終えて、型についての詳細を見るためにこのページに戻ってきた場合は、良いリソースとして `mypy` の「チートシート」 があります。
///
diff --git a/docs/ja/docs/resources/index.md b/docs/ja/docs/resources/index.md
new file mode 100644
index 000000000..15a949e01
--- /dev/null
+++ b/docs/ja/docs/resources/index.md
@@ -0,0 +1,3 @@
+# リソース { #resources }
+
+追加リソース、外部リンクなど。✈️
diff --git a/docs/ja/docs/translation-banner.md b/docs/ja/docs/translation-banner.md
new file mode 100644
index 000000000..351a82a35
--- /dev/null
+++ b/docs/ja/docs/translation-banner.md
@@ -0,0 +1,11 @@
+/// details | 🌐 AI と人間による翻訳
+
+この翻訳は、人間のガイドに基づいて AI によって作成されました。🤝
+
+原文の意図を取り違えていたり、不自然な表現になっている可能性があります。🤖
+
+[AI LLM をより適切に誘導するのを手伝う](https://fastapi.tiangolo.com/ja/contributing/#translations) ことで、この翻訳を改善できます。
+
+[英語版](ENGLISH_VERSION_URL)
+
+///
diff --git a/docs/ja/docs/tutorial/background-tasks.md b/docs/ja/docs/tutorial/background-tasks.md
index 0ed41ce11..d32c141b5 100644
--- a/docs/ja/docs/tutorial/background-tasks.md
+++ b/docs/ja/docs/tutorial/background-tasks.md
@@ -15,7 +15,7 @@
まず初めに、`BackgroundTasks` をインポートし、`BackgroundTasks` の型宣言と共に、*path operation function* のパラメーターを定義します:
-{* ../../docs_src/background_tasks/tutorial001_py39.py hl[1,13] *}
+{* ../../docs_src/background_tasks/tutorial001_py310.py hl[1,13] *}
**FastAPI** は、`BackgroundTasks` 型のオブジェクトを作成し、そのパラメーターに渡します。
@@ -31,13 +31,13 @@
また、書き込み操作では `async` と `await` を使用しないため、通常の `def` で関数を定義します。
-{* ../../docs_src/background_tasks/tutorial001_py39.py hl[6:9] *}
+{* ../../docs_src/background_tasks/tutorial001_py310.py hl[6:9] *}
## バックグラウンドタスクの追加 { #add-the-background-task }
*path operation function* 内で、`.add_task()` メソッドを使用してタスク関数を *background tasks* オブジェクトに渡します。
-{* ../../docs_src/background_tasks/tutorial001_py39.py hl[14] *}
+{* ../../docs_src/background_tasks/tutorial001_py310.py hl[14] *}
`.add_task()` は以下の引数を受け取ります:
diff --git a/docs/ja/docs/tutorial/bigger-applications.md b/docs/ja/docs/tutorial/bigger-applications.md
new file mode 100644
index 000000000..9c1cc0fe6
--- /dev/null
+++ b/docs/ja/docs/tutorial/bigger-applications.md
@@ -0,0 +1,504 @@
+# 大規模アプリケーション - 複数ファイル { #bigger-applications-multiple-files }
+
+アプリケーションや Web API を作る場合、すべてを1つのファイルに収められることはほとんどありません。
+
+**FastAPI** は、柔軟性を保ったままアプリケーションを構造化できる便利なツールを提供します。
+
+/// info | 情報
+
+Flask 出身であれば、Flask の Blueprint に相当します。
+
+///
+
+## 例のファイル構成 { #an-example-file-structure }
+
+次のようなファイル構成があるとします:
+
+```
+.
+├── app
+│ ├── __init__.py
+│ ├── main.py
+│ ├── dependencies.py
+│ └── routers
+│ │ ├── __init__.py
+│ │ ├── items.py
+│ │ └── users.py
+│ └── internal
+│ ├── __init__.py
+│ └── admin.py
+```
+
+/// tip | 豆知識
+
+複数の `__init__.py` ファイルがあります: 各ディレクトリやサブディレクトリに1つずつです。
+
+これにより、あるファイルから別のファイルへコードをインポートできます。
+
+例えば、`app/main.py` では次のように書けます:
+
+```
+from app.routers import items
+```
+
+///
+
+* `app` ディレクトリはすべてを含みます。そして空のファイル `app/__init__.py` があり、「Python パッケージ」(「Python モジュール」の集合): `app` です。
+* `app/main.py` ファイルがあります。Python パッケージ(`__init__.py` のあるディレクトリ)の中にあるため、そのパッケージの「モジュール」: `app.main` です。
+* `app/dependencies.py` ファイルもあり、`app/main.py` と同様に「モジュール」: `app.dependencies` です。
+* `app/routers/` サブディレクトリに別の `__init__.py` があるので、「Python サブパッケージ」: `app.routers` です。
+* `app/routers/items.py` はパッケージ `app/routers/` 内のファイルなので、サブモジュール: `app.routers.items` です。
+* `app/routers/users.py` も同様で、別のサブモジュール: `app.routers.users` です。
+* `app/internal/` サブディレクトリにも `__init__.py` があるので、別の「Python サブパッケージ」: `app.internal` です。
+* `app/internal/admin.py` は別のサブモジュール: `app.internal.admin` です。
+
+
+
+## 同じルーターを異なる `prefix` で複数回取り込む { #include-the-same-router-multiple-times-with-different-prefix }
+
+同じルーターに対して、異なる prefix で `.include_router()` を複数回使うこともできます。
+
+例えば、同じ API を `/api/v1` と `/api/latest` のように異なる prefix で公開する場合に役立ちます。
+
+高度な使い方なので不要かもしれませんが、必要な場合に備えて用意されています。
+
+## `APIRouter` を別の `APIRouter` に取り込む { #include-an-apirouter-in-another }
+
+`APIRouter` を `FastAPI` アプリケーションに取り込めるのと同じように、`APIRouter` を別の `APIRouter` に取り込むこともできます:
+
+```Python
+router.include_router(other_router)
+```
+
+`router` を `FastAPI` アプリに取り込む前にこれを実行して、`other_router` の *path operations* も含まれるようにしてください。
diff --git a/docs/ja/docs/tutorial/body-multiple-params.md b/docs/ja/docs/tutorial/body-multiple-params.md
index 4ce77cc0d..0f81f4c46 100644
--- a/docs/ja/docs/tutorial/body-multiple-params.md
+++ b/docs/ja/docs/tutorial/body-multiple-params.md
@@ -106,12 +106,6 @@
q: str | None = None
```
-またはPython 3.10以上では:
-
-```Python
-q: Union[str, None] = None
-```
-
例えば:
{* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *}
diff --git a/docs/ja/docs/tutorial/body-nested-models.md b/docs/ja/docs/tutorial/body-nested-models.md
index 24eb30208..ab78b8f86 100644
--- a/docs/ja/docs/tutorial/body-nested-models.md
+++ b/docs/ja/docs/tutorial/body-nested-models.md
@@ -164,7 +164,7 @@ images: list[Image]
以下のように:
-{* ../../docs_src/body_nested_models/tutorial008_py39.py hl[13] *}
+{* ../../docs_src/body_nested_models/tutorial008_py310.py hl[13] *}
## あらゆる場所でのエディタサポート { #editor-support-everywhere }
@@ -194,7 +194,7 @@ Pydanticモデルではなく、`dict`を直接使用している場合はこの
この場合、`int`のキーと`float`の値を持つものであれば、どんな`dict`でも受け入れることができます:
-{* ../../docs_src/body_nested_models/tutorial009_py39.py hl[7] *}
+{* ../../docs_src/body_nested_models/tutorial009_py310.py hl[7] *}
/// tip | 豆知識
diff --git a/docs/ja/docs/tutorial/body-updates.md b/docs/ja/docs/tutorial/body-updates.md
index e888d5a0d..310530c69 100644
--- a/docs/ja/docs/tutorial/body-updates.md
+++ b/docs/ja/docs/tutorial/body-updates.md
@@ -68,7 +68,7 @@
まとめると、部分的な更新を適用するには、次のようにします:
-* (オプションで)`PUT`の代わりに`PATCH`を使用します。
+* (オプションで)`PATCH`の代わりに`PUT`を使用します。
* 保存されているデータを取得します。
* そのデータをPydanticモデルにいれます。
* 入力モデルからデフォルト値を含まない`dict`を生成します(`exclude_unset`を使用します)。
diff --git a/docs/ja/docs/tutorial/body.md b/docs/ja/docs/tutorial/body.md
index a219faed0..7c939bdfa 100644
--- a/docs/ja/docs/tutorial/body.md
+++ b/docs/ja/docs/tutorial/body.md
@@ -74,7 +74,7 @@ APIはほとんどの場合 **レスポンス** ボディを送信する必要
* 受け取ったデータをパラメータ `item` に渡します。
* 関数内で `Item` 型として宣言したため、すべての属性とその型について、エディタサポート(補完など)も利用できます。
* モデル向けの JSON Schema 定義を生成します。プロジェクトにとって意味があるなら、他の場所でも好きなように利用できます。
-* それらのスキーマは生成されるOpenAPIスキーマの一部となり、自動ドキュメントの UIs で使用されます。
+* それらのスキーマは生成されるOpenAPIスキーマの一部となり、自動ドキュメントの UIs で使用されます。
## 自動ドキュメント { #automatic-docs }
@@ -155,7 +155,7 @@ APIはほとんどの場合 **レスポンス** ボディを送信する必要
FastAPIは、デフォルト値 `= None` があるため、`q` の値が必須ではないことを認識します。
-`str | None`(Python 3.10+)や `Union[str, None]`(Python 3.9+)の `Union` は、値が必須ではないことを判断するためにFastAPIでは使用されません。`= None` というデフォルト値があるため、必須ではないことを認識します。
+`str | None` は、値が必須ではないことを判断するためにFastAPIでは使用されません。`= None` というデフォルト値があるため、必須ではないことを認識します。
しかし、型アノテーションを追加すると、エディタがより良いサポートを提供し、エラーを検出できるようになります。
diff --git a/docs/ja/docs/tutorial/cookie-param-models.md b/docs/ja/docs/tutorial/cookie-param-models.md
index 10ffb2566..89ae42438 100644
--- a/docs/ja/docs/tutorial/cookie-param-models.md
+++ b/docs/ja/docs/tutorial/cookie-param-models.md
@@ -46,7 +46,7 @@
特定の(あまり一般的ではないかもしれない)ケースで、受け付けるクッキーを**制限**する必要があるかもしれません。
-あなたのAPIは独自の クッキー同意 を管理する能力を持っています。 🤪🍪
+あなたのAPIは独自の クッキー同意 を管理する能力を持っています。 🤪🍪
Pydanticのモデルの Configuration を利用して、 `extra` フィールドを `forbid` とすることができます。
@@ -54,9 +54,9 @@ Pydanticのモデルの Configuration を利用して、 `extra` フィールド
もしクライアントが**余分なクッキー**を送ろうとすると、**エラー**レスポンスが返されます。
-どうせAPIに拒否されるのにあなたの同意を得ようと精一杯努力する可哀想なクッキーバナーたち... 🍪
+どうせAPIに拒否されるのにあなたの同意を得ようと精一杯努力する可哀想なクッキーバナーたち... 🍪
-例えば、クライアントがクッキー `santa_tracker` を `good-list-please` という値で送ろうとすると、`santa_tracker` という クッキーが許可されていない ことを通知する**エラー**レスポンスが返されます:
+例えば、クライアントがクッキー `santa_tracker` を `good-list-please` という値で送ろうとすると、`santa_tracker` という クッキーが許可されていない ことを通知する**エラー**レスポンスが返されます:
```json
{
@@ -73,4 +73,4 @@ Pydanticのモデルの Configuration を利用して、 `extra` フィールド
## まとめ { #summary }
-**FastAPI**では、**クッキー**を宣言するために、**Pydanticモデル**を使用できます。😎
+**FastAPI**では、**クッキー**を宣言するために、**Pydanticモデル**を使用できます。😎
diff --git a/docs/ja/docs/tutorial/cors.md b/docs/ja/docs/tutorial/cors.md
index a1dfe8e62..5136a7fd5 100644
--- a/docs/ja/docs/tutorial/cors.md
+++ b/docs/ja/docs/tutorial/cors.md
@@ -46,7 +46,7 @@
* 特定のHTTPメソッド (`POST`、`PUT`) またはワイルドカード `"*"` を使用してすべて許可。
* 特定のHTTPヘッダー、またはワイルドカード `"*"`を使用してすべて許可。
-{* ../../docs_src/cors/tutorial001_py39.py hl[2,6:11,13:19] *}
+{* ../../docs_src/cors/tutorial001_py310.py hl[2,6:11,13:19] *}
`CORSMiddleware` 実装で使用されるデフォルトのパラメータはデフォルトで制限が厳しいため、ブラウザがクロスドメインのコンテキストでそれらを使用できるようにするには、特定のオリジン、メソッド、またはヘッダーを明示的に有効にする必要があります。
diff --git a/docs/ja/docs/tutorial/debugging.md b/docs/ja/docs/tutorial/debugging.md
index 8fe5b2d5d..9d88ba42b 100644
--- a/docs/ja/docs/tutorial/debugging.md
+++ b/docs/ja/docs/tutorial/debugging.md
@@ -6,7 +6,7 @@ Visual Studio CodeやPyCharmなどを使用して、エディター上でデバ
FastAPIアプリケーション上で、`uvicorn` を直接インポートして実行します:
-{* ../../docs_src/debugging/tutorial001_py39.py hl[1,15] *}
+{* ../../docs_src/debugging/tutorial001_py310.py hl[1,15] *}
### `__name__ == "__main__"` について { #about-name-main }
diff --git a/docs/ja/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/ja/docs/tutorial/dependencies/classes-as-dependencies.md
index 3cb1fe73d..21de5b978 100644
--- a/docs/ja/docs/tutorial/dependencies/classes-as-dependencies.md
+++ b/docs/ja/docs/tutorial/dependencies/classes-as-dependencies.md
@@ -101,7 +101,7 @@ FastAPIが実際にチェックしているのは、それが「呼び出し可
上のコードでは`CommonQueryParams`を2回書いていることに注目してください:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
@@ -109,7 +109,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
@@ -137,7 +137,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams)
この場合、以下にある最初の`CommonQueryParams`:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[CommonQueryParams, ...
@@ -145,7 +145,7 @@ commons: Annotated[CommonQueryParams, ...
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
@@ -163,7 +163,7 @@ commons: CommonQueryParams ...
実際には以下のように書けばいいだけです:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[Any, Depends(CommonQueryParams)]
@@ -171,7 +171,7 @@ commons: Annotated[Any, Depends(CommonQueryParams)]
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
@@ -197,7 +197,7 @@ commons = Depends(CommonQueryParams)
しかし、ここでは`CommonQueryParams`を2回書くというコードの繰り返しが発生していることがわかります:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
@@ -205,7 +205,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
@@ -225,7 +225,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams)
以下のように書く代わりに:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
@@ -233,7 +233,7 @@ commons: Annotated[CommonQueryParams, Depends(CommonQueryParams)]
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
@@ -249,7 +249,7 @@ commons: CommonQueryParams = Depends(CommonQueryParams)
...以下のように書きます:
-//// tab | Python 3.9+
+//// tab | Python 3.10+
```Python
commons: Annotated[CommonQueryParams, Depends()]
@@ -257,7 +257,7 @@ commons: Annotated[CommonQueryParams, Depends()]
////
-//// tab | Python 3.9+ 注釈なし
+//// tab | Python 3.10+ 注釈なし
/// tip | 豆知識
diff --git a/docs/ja/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md b/docs/ja/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md
index 2051afc05..d0a2b1672 100644
--- a/docs/ja/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md
+++ b/docs/ja/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md
@@ -14,7 +14,7 @@
それは`Depends()`の`list`であるべきです:
-{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[19] *}
+{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[19] *}
これらの依存関係は、通常の依存関係と同様に実行・解決されます。しかし、それらの値(何かを返す場合)は*path operation 関数*には渡されません。
@@ -44,13 +44,13 @@
これらはリクエストの要件(ヘッダーのようなもの)やその他のサブ依存関係を宣言できます:
-{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[8,13] *}
+{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[8,13] *}
### 例外の発生 { #raise-exceptions }
これらの依存関係は、通常の依存関係と同じように例外を`raise`できます:
-{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[10,15] *}
+{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[10,15] *}
### 戻り値 { #return-values }
@@ -58,7 +58,7 @@
つまり、すでにどこかで使っている通常の依存関係(値を返すもの)を再利用でき、値は使われなくても依存関係は実行されます:
-{* ../../docs_src/dependencies/tutorial006_an_py39.py hl[11,16] *}
+{* ../../docs_src/dependencies/tutorial006_an_py310.py hl[11,16] *}
## *path operation*のグループに対する依存関係 { #dependencies-for-a-group-of-path-operations }
diff --git a/docs/ja/docs/tutorial/dependencies/dependencies-with-yield.md b/docs/ja/docs/tutorial/dependencies/dependencies-with-yield.md
index 8095114c3..380dcb536 100644
--- a/docs/ja/docs/tutorial/dependencies/dependencies-with-yield.md
+++ b/docs/ja/docs/tutorial/dependencies/dependencies-with-yield.md
@@ -1,6 +1,6 @@
# `yield`を持つ依存関係 { #dependencies-with-yield }
-FastAPIは、いくつかの終了後の追加のステップを行う依存関係をサポートしています。
+FastAPIは、いくつかの終了後の追加のステップを行う依存関係をサポートしています。
これを行うには、`return`の代わりに`yield`を使い、その後に追加のステップ(コード)を書きます。
@@ -29,15 +29,15 @@ FastAPIは、いくつかの
+
+
+
+## 余分なヘッダーを禁止 { #forbid-extra-headers }
+
+特殊なユースケース(あまり一般的ではありません)では、受け付けるヘッダーを**制限**したい場合があります。
+
+Pydantic のモデル設定で `extra` フィールドを `forbid` にして禁止できます:
+
+{* ../../docs_src/header_param_models/tutorial002_an_py310.py hl[10] *}
+
+クライアントが**余分なヘッダー**を送信しようとすると、**エラー**レスポンスが返されます。
+
+例えば、クライアントが値 `plumbus` の `tool` ヘッダーを送ろうとすると、ヘッダーパラメータ `tool` は許可されていない旨の**エラー**レスポンスが返されます:
+
+```json
+{
+ "detail": [
+ {
+ "type": "extra_forbidden",
+ "loc": ["header", "tool"],
+ "msg": "Extra inputs are not permitted",
+ "input": "plumbus",
+ }
+ ]
+}
+```
+
+## アンダースコア変換の無効化 { #disable-convert-underscores }
+
+通常のヘッダーパラメータと同様に、パラメータ名にアンダースコアがある場合は**自動的にハイフンに変換**されます。
+
+例えば、コード上でヘッダーパラメータ `save_data` を定義すると、想定される HTTP ヘッダーは `save-data` となり、ドキュメント上にもそのように表示されます。
+
+何らかの理由でこの自動変換を無効化する必要がある場合、ヘッダーパラメータ用の Pydantic モデルでも無効化できます。
+
+{* ../../docs_src/header_param_models/tutorial003_an_py310.py hl[19] *}
+
+/// warning | 注意
+
+`convert_underscores` を `False` に設定する前に、アンダースコアを含むヘッダーの使用を禁止している HTTP プロキシやサーバーがあることに留意してください。
+
+///
+
+## まとめ { #summary }
+
+**Pydantic モデル**を使って **FastAPI** で **ヘッダー**を宣言できます。😎
diff --git a/docs/ja/docs/tutorial/metadata.md b/docs/ja/docs/tutorial/metadata.md
index 0ffb8f350..3b70bf2f4 100644
--- a/docs/ja/docs/tutorial/metadata.md
+++ b/docs/ja/docs/tutorial/metadata.md
@@ -18,7 +18,7 @@ OpenAPI仕様および自動APIドキュメントUIで使用される次のフ
以下のように設定できます:
-{* ../../docs_src/metadata/tutorial001_py39.py hl[3:16, 19:32] *}
+{* ../../docs_src/metadata/tutorial001_py310.py hl[3:16, 19:32] *}
/// tip | 豆知識
@@ -36,7 +36,7 @@ OpenAPI 3.1.0 および FastAPI 0.99.0 以降では、`license_info` を `url`
例:
-{* ../../docs_src/metadata/tutorial001_1_py39.py hl[31] *}
+{* ../../docs_src/metadata/tutorial001_1_py310.py hl[31] *}
## タグのメタデータ { #metadata-for-tags }
@@ -58,7 +58,7 @@ OpenAPI 3.1.0 および FastAPI 0.99.0 以降では、`license_info` を `url`
タグのメタデータを作成し、それを `openapi_tags` パラメータに渡します:
-{* ../../docs_src/metadata/tutorial004_py39.py hl[3:16,18] *}
+{* ../../docs_src/metadata/tutorial004_py310.py hl[3:16,18] *}
説明の中でMarkdownを使用できることに注意してください。たとえば「login」は太字 (**login**) で表示され、「fancy」は斜体 (_fancy_) で表示されます。
@@ -72,7 +72,7 @@ OpenAPI 3.1.0 および FastAPI 0.99.0 以降では、`license_info` を `url`
*path operation*(および `APIRouter`)の `tags` パラメータを使用して、それらを異なるタグに割り当てます:
-{* ../../docs_src/metadata/tutorial004_py39.py hl[21,26] *}
+{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *}
/// info | 情報
@@ -100,7 +100,7 @@ OpenAPI 3.1.0 および FastAPI 0.99.0 以降では、`license_info` を `url`
たとえば、`/api/v1/openapi.json` で提供されるように設定するには:
-{* ../../docs_src/metadata/tutorial002_py39.py hl[3] *}
+{* ../../docs_src/metadata/tutorial002_py310.py hl[3] *}
OpenAPIスキーマを完全に無効にする場合は、`openapi_url=None` を設定できます。これにより、それを使用するドキュメントUIも無効になります。
@@ -117,4 +117,4 @@ OpenAPIスキーマを完全に無効にする場合は、`openapi_url=None` を
たとえば、`/documentation` でSwagger UIが提供されるように設定し、ReDocを無効にするには:
-{* ../../docs_src/metadata/tutorial003_py39.py hl[3] *}
+{* ../../docs_src/metadata/tutorial003_py310.py hl[3] *}
diff --git a/docs/ja/docs/tutorial/middleware.md b/docs/ja/docs/tutorial/middleware.md
index 12fb57a64..103d6e2c0 100644
--- a/docs/ja/docs/tutorial/middleware.md
+++ b/docs/ja/docs/tutorial/middleware.md
@@ -31,7 +31,7 @@
* 次に、対応する*path operation*によって生成された `response` を返します。
* その後、`response` を返す前にさらに `response` を変更することもできます。
-{* ../../docs_src/middleware/tutorial001_py39.py hl[8:9,11,14] *}
+{* ../../docs_src/middleware/tutorial001_py310.py hl[8:9,11,14] *}
/// tip | 豆知識
@@ -57,7 +57,7 @@
例えば、リクエストの処理とレスポンスの生成にかかった秒数を含むカスタムヘッダー `X-Process-Time` を追加できます:
-{* ../../docs_src/middleware/tutorial001_py39.py hl[10,12:13] *}
+{* ../../docs_src/middleware/tutorial001_py310.py hl[10,12:13] *}
/// tip | 豆知識
@@ -92,4 +92,4 @@ app.add_middleware(MiddlewareB)
他のミドルウェアの詳細については、[高度なユーザーガイド: 高度なミドルウェア](../advanced/middleware.md){.internal-link target=_blank}を参照してください。
-次のセクションでは、ミドルウェアを使用して CORS を処理する方法について説明します。
+次のセクションでは、ミドルウェアを使用して CORS を処理する方法について説明します。
diff --git a/docs/ja/docs/tutorial/path-operation-configuration.md b/docs/ja/docs/tutorial/path-operation-configuration.md
index eb6b6b11a..556cc6b14 100644
--- a/docs/ja/docs/tutorial/path-operation-configuration.md
+++ b/docs/ja/docs/tutorial/path-operation-configuration.md
@@ -46,7 +46,7 @@
**FastAPI** は、プレーンな文字列の場合と同じ方法でそれをサポートしています:
-{* ../../docs_src/path_operation_configuration/tutorial002b_py39.py hl[1,8:10,13,18] *}
+{* ../../docs_src/path_operation_configuration/tutorial002b_py310.py hl[1,8:10,13,18] *}
## 概要と説明 { #summary-and-description }
@@ -56,7 +56,7 @@
## docstringを用いた説明 { #description-from-docstring }
-説明文は長くて複数行におよぶ傾向があるので、関数docstring内に*path operation*の説明文を宣言できます。すると、**FastAPI** は説明文を読み込んでくれます。
+説明文は長くて複数行におよぶ傾向があるので、関数docstring内に*path operation*の説明文を宣言できます。すると、**FastAPI** は説明文を読み込んでくれます。
docstringにMarkdownを記述すれば、正しく解釈されて表示されます。(docstringのインデントを考慮して)
@@ -90,9 +90,9 @@ OpenAPIは*path operation*ごとにレスポンスの説明を必要としてい
## *path operation*を非推奨にする { #deprecate-a-path-operation }
-*path operation*をdeprecatedとしてマークする必要があるが、それを削除しない場合は、`deprecated`パラメータを渡します:
+*path operation*をdeprecatedとしてマークする必要があるが、それを削除しない場合は、`deprecated`パラメータを渡します:
-{* ../../docs_src/path_operation_configuration/tutorial006_py39.py hl[16] *}
+{* ../../docs_src/path_operation_configuration/tutorial006_py310.py hl[16] *}
対話的ドキュメントでは非推奨と明記されます:
diff --git a/docs/ja/docs/tutorial/path-params-numeric-validations.md b/docs/ja/docs/tutorial/path-params-numeric-validations.md
index 6a9ecc4e7..ab3240f04 100644
--- a/docs/ja/docs/tutorial/path-params-numeric-validations.md
+++ b/docs/ja/docs/tutorial/path-params-numeric-validations.md
@@ -54,11 +54,11 @@ Pythonは「デフォルト」を持つ値を「デフォルト」を持たな
そのため、以下のように関数を宣言することができます:
-{* ../../docs_src/path_params_numeric_validations/tutorial002_py39.py hl[7] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial002_py310.py hl[7] *}
ただし、`Annotated`を使う場合はこの問題は起きないことを覚えておいてください。`Query()`や`Path()`に関数パラメータのデフォルト値を使わないためです。
-{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py39.py *}
+{* ../../docs_src/path_params_numeric_validations/tutorial002_an_py310.py *}
## 必要に応じてパラメータを並び替えるトリック { #order-the-parameters-as-you-need-tricks }
@@ -81,15 +81,15 @@ Pythonは「デフォルト」を持つ値を「デフォルト」を持たな
関数の最初のパラメータとして`*`を渡します。
-Pythonはその`*`で何かをすることはありませんが、それ以降のすべてのパラメータがキーワード引数(キーと値のペア)として呼ばれるべきものであると知っているでしょう。それはkwargsとしても知られています。たとえデフォルト値がなくても。
+Pythonはその`*`で何かをすることはありませんが、それ以降のすべてのパラメータがキーワード引数(キーと値のペア)として呼ばれるべきものであると知っているでしょう。それはkwargsとしても知られています。たとえデフォルト値がなくても。
-{* ../../docs_src/path_params_numeric_validations/tutorial003_py39.py hl[7] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial003_py310.py hl[7] *}
### `Annotated`のほうがよい { #better-with-annotated }
`Annotated`を使う場合は、関数パラメータのデフォルト値を使わないため、この問題は起きず、おそらく`*`を使う必要もありません。
-{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py39.py hl[10] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial003_an_py310.py hl[10] *}
## 数値の検証: 以上 { #number-validations-greater-than-or-equal }
@@ -97,7 +97,7 @@ Pythonはその`*`で何かをすることはありませんが、それ以降
ここで、`ge=1`の場合、`item_id`は`1`「より大きい`g`か、同じ`e`」整数でなければなりません。
-{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py39.py hl[10] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial004_an_py310.py hl[10] *}
## 数値の検証: より大きいと小なりイコール { #number-validations-greater-than-and-less-than-or-equal }
@@ -106,7 +106,7 @@ Pythonはその`*`で何かをすることはありませんが、それ以降
* `gt`: `g`reater `t`han
* `le`: `l`ess than or `e`qual
-{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py39.py hl[10] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial005_an_py310.py hl[10] *}
## 数値の検証: 浮動小数点、 大なり小なり { #number-validations-floats-greater-than-and-less-than }
@@ -118,7 +118,7 @@ Pythonはその`*`で何かをすることはありませんが、それ以降
これはltも同じです。
-{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py39.py hl[13] *}
+{* ../../docs_src/path_params_numeric_validations/tutorial006_an_py310.py hl[13] *}
## まとめ { #recap }
diff --git a/docs/ja/docs/tutorial/path-params.md b/docs/ja/docs/tutorial/path-params.md
index 96a1fe9d1..5b78eb7b1 100644
--- a/docs/ja/docs/tutorial/path-params.md
+++ b/docs/ja/docs/tutorial/path-params.md
@@ -2,7 +2,7 @@
Pythonのformat文字列と同様のシンタックスで「パスパラメータ」や「パス変数」を宣言できます:
-{* ../../docs_src/path_params/tutorial001_py39.py hl[6:7] *}
+{* ../../docs_src/path_params/tutorial001_py310.py hl[6:7] *}
パスパラメータ `item_id` の値は、引数 `item_id` として関数に渡されます。
@@ -16,7 +16,7 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
標準のPythonの型アノテーションを使用して、関数内のパスパラメータの型を宣言できます:
-{* ../../docs_src/path_params/tutorial002_py39.py hl[7] *}
+{* ../../docs_src/path_params/tutorial002_py310.py hl[7] *}
ここでは、 `item_id` は `int` として宣言されています。
@@ -26,7 +26,7 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
///
-## データ変換 { #data-conversion }
+## データ変換 { #data-conversion }
この例を実行し、ブラウザで http://127.0.0.1:8000/items/3 を開くと、次のレスポンスが表示されます:
@@ -38,7 +38,7 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
関数が受け取った(および返した)値は、文字列の `"3"` ではなく、Pythonの `int` としての `3` であることに注意してください。
-したがって、その型宣言を使うと、**FastAPI**は自動リクエスト "解析" を行います。
+したがって、その型宣言を使うと、**FastAPI**は自動リクエスト "解析" を行います。
///
@@ -118,13 +118,13 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
*path operations* は順に評価されるので、 `/users/me` が `/users/{user_id}` よりも先に宣言されているか確認する必要があります:
-{* ../../docs_src/path_params/tutorial003_py39.py hl[6,11] *}
+{* ../../docs_src/path_params/tutorial003_py310.py hl[6,11] *}
それ以外の場合、 `/users/{user_id}` は `/users/me` としてもマッチします。値が `"me"` であるパラメータ `user_id` を受け取ると「考え」ます。
同様に、path operation を再定義することはできません:
-{* ../../docs_src/path_params/tutorial003b_py39.py hl[6,11] *}
+{* ../../docs_src/path_params/tutorial003b_py310.py hl[6,11] *}
パスは最初にマッチしたものが常に使われるため、最初のものが常に使用されます。
@@ -140,11 +140,11 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
そして、固定値のクラス属性を作ります。すると、その値が使用可能な値となります:
-{* ../../docs_src/path_params/tutorial005_py39.py hl[1,6:9] *}
+{* ../../docs_src/path_params/tutorial005_py310.py hl[1,6:9] *}
/// tip | 豆知識
-"AlexNet"、"ResNet"そして"LeNet"は機械学習モデルの名前です。
+"AlexNet"、"ResNet"そして"LeNet"は機械学習モデルの名前です。
///
@@ -152,7 +152,7 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
次に、作成したenumクラスである`ModelName`を使用した型アノテーションをもつ*パスパラメータ*を作成します:
-{* ../../docs_src/path_params/tutorial005_py39.py hl[16] *}
+{* ../../docs_src/path_params/tutorial005_py310.py hl[16] *}
### ドキュメントの確認 { #check-the-docs }
@@ -168,13 +168,13 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
これは、作成した列挙型 `ModelName` の*列挙型メンバ*と比較できます:
-{* ../../docs_src/path_params/tutorial005_py39.py hl[17] *}
+{* ../../docs_src/path_params/tutorial005_py310.py hl[17] *}
#### *列挙値*の取得 { #get-the-enumeration-value }
`model_name.value` 、もしくは一般に、 `your_enum_member.value` を使用して実際の値 (この場合は `str`) を取得できます。
-{* ../../docs_src/path_params/tutorial005_py39.py hl[20] *}
+{* ../../docs_src/path_params/tutorial005_py310.py hl[20] *}
/// tip | 豆知識
@@ -188,7 +188,7 @@ Pythonのformat文字列と同様のシンタックスで「パスパラメー
それらはクライアントに返される前に適切な値 (この場合は文字列) に変換されます。
-{* ../../docs_src/path_params/tutorial005_py39.py hl[18,21,23] *}
+{* ../../docs_src/path_params/tutorial005_py310.py hl[18,21,23] *}
クライアントは以下の様なJSONレスポンスを得ます:
@@ -227,7 +227,7 @@ Starletteのオプションを直接使用することで、以下のURLの様
したがって、以下の様に使用できます:
-{* ../../docs_src/path_params/tutorial004_py39.py hl[6] *}
+{* ../../docs_src/path_params/tutorial004_py310.py hl[6] *}
/// tip | 豆知識
@@ -242,7 +242,7 @@ Starletteのオプションを直接使用することで、以下のURLの様
簡潔で、本質的で、標準的なPythonの型宣言を使用することで、**FastAPI**は以下を行います:
* エディターサポート: エラーチェック、自動補完、など
-* データ「解析」
+* データ「解析」
* データバリデーション
* APIアノテーションと自動ドキュメント生成
diff --git a/docs/ja/docs/tutorial/query-params-str-validations.md b/docs/ja/docs/tutorial/query-params-str-validations.md
index e230ef29a..dda4e120b 100644
--- a/docs/ja/docs/tutorial/query-params-str-validations.md
+++ b/docs/ja/docs/tutorial/query-params-str-validations.md
@@ -47,40 +47,16 @@ FastAPI はバージョン 0.95.0 で `Annotated` のサポートを追加し(
次の型アノテーションがありました:
-//// tab | Python 3.10+
-
```Python
q: str | None = None
```
-////
-
-//// tab | Python 3.9+
-
-```Python
-q: Union[str, None] = None
-```
-
-////
-
これを `Annotated` で包んで、次のようにします:
-//// tab | Python 3.10+
-
```Python
q: Annotated[str | None] = None
```
-////
-
-//// tab | Python 3.9+
-
-```Python
-q: Annotated[Union[str, None]] = None
-```
-
-////
-
どちらも同じ意味で、`q` は `str` または `None` になり得るパラメータで、デフォルトでは `None` です。
では、面白いところに進みましょう。 🎉
@@ -109,7 +85,7 @@ FastAPI は次を行います:
## 代替(古い方法): デフォルト値としての `Query` { #alternative-old-query-as-the-default-value }
-FastAPI の以前のバージョン(0.95.0 より前)では、パラメータのデフォルト値として `Query` を使う必要があり、`Annotated` の中に入れるのではありませんでした。これを使ったコードを見かける可能性が高いので、説明します。
+FastAPI の以前のバージョン(0.95.0 より前)では、パラメータのデフォルト値として `Query` を使う必要があり、`Annotated` の中に入れるのではありませんでした。これを使ったコードを見かける可能性が高いので、説明します。
/// tip | 豆知識
@@ -192,7 +168,7 @@ FastAPI なしで同じ関数を **別の場所** から **呼び出しても**
## 正規表現の追加 { #add-regular-expressions }
-パラメータが一致するべき 正規表現 `pattern` を定義することができます:
+パラメータが一致するべき 正規表現 `pattern` を定義することができます:
{* ../../docs_src/query_params_str_validations/tutorial004_an_py310.py hl[11] *}
@@ -212,7 +188,7 @@ FastAPI なしで同じ関数を **別の場所** から **呼び出しても**
クエリパラメータ `q` の `min_length` を `3` とし、デフォルト値を `"fixedquery"` として宣言したいとします:
-{* ../../docs_src/query_params_str_validations/tutorial005_an_py39.py hl[9] *}
+{* ../../docs_src/query_params_str_validations/tutorial005_an_py310.py hl[9] *}
/// note | 備考
@@ -242,7 +218,7 @@ q: Annotated[str | None, Query(min_length=3)] = None
そのため、`Query` を使いながら値を必須として宣言したい場合は、単にデフォルト値を宣言しません:
-{* ../../docs_src/query_params_str_validations/tutorial006_an_py39.py hl[9] *}
+{* ../../docs_src/query_params_str_validations/tutorial006_an_py310.py hl[9] *}
### 必須、`None` にできる { #required-can-be-none }
@@ -293,7 +269,7 @@ http://localhost:8000/items/?q=foo&q=bar
また、値が指定されていない場合はデフォルトの `list` を定義することもできます。
-{* ../../docs_src/query_params_str_validations/tutorial012_an_py39.py hl[9] *}
+{* ../../docs_src/query_params_str_validations/tutorial012_an_py310.py hl[9] *}
以下にアクセスすると:
@@ -316,7 +292,7 @@ http://localhost:8000/items/
`list[str]` の代わりに直接 `list` を使うこともできます:
-{* ../../docs_src/query_params_str_validations/tutorial013_an_py39.py hl[9] *}
+{* ../../docs_src/query_params_str_validations/tutorial013_an_py310.py hl[9] *}
/// note | 備考
@@ -372,7 +348,7 @@ http://127.0.0.1:8000/items/?item-query=foobaritems
さて、このパラメータが気に入らなくなったとしましょう。
-それを使っているクライアントがいるので、しばらくは残しておく必要がありますが、ドキュメントにはdeprecatedと明記しておきたいです。
+それを使っているクライアントがいるので、しばらくは残しておく必要がありますが、ドキュメントにはdeprecatedと明記しておきたいです。
その場合、`Query`にパラメータ`deprecated=True`を渡します:
@@ -402,7 +378,7 @@ Pydantic には ISBN の書籍番号なら item ID が `isbn-` で始まること、IMDB の movie URL ID なら `imdb-` で始まることをチェックします:
+例えば、このカスタムバリデータは、ISBN の書籍番号なら item ID が `isbn-` で始まること、IMDB の movie URL ID なら `imdb-` で始まることをチェックします:
{* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *}
@@ -436,7 +412,7 @@ Pydantic には 反復可能オブジェクト を取得します。
+`data.items()` で、辞書の各アイテムのキーと値を含むタプルを持つ 反復可能オブジェクト を取得します。
この反復可能オブジェクトを `list(data.items())` で適切な `list` に変換します。
diff --git a/docs/ja/docs/tutorial/query-params.md b/docs/ja/docs/tutorial/query-params.md
index 41e51ed78..d32c9822b 100644
--- a/docs/ja/docs/tutorial/query-params.md
+++ b/docs/ja/docs/tutorial/query-params.md
@@ -2,7 +2,7 @@
パスパラメータではない関数パラメータを宣言すると、それらは自動的に「クエリ」パラメータとして解釈されます。
-{* ../../docs_src/query_params/tutorial001_py39.py hl[9] *}
+{* ../../docs_src/query_params/tutorial001_py310.py hl[9] *}
クエリはURL内で `?` の後に続くキーとバリューの組で、 `&` で区切られています。
@@ -24,7 +24,7 @@ http://127.0.0.1:8000/items/?skip=0&limit=10
パスパラメータに適用される処理と完全に同様な処理がクエリパラメータにも施されます:
* エディターサポート (明らかに)
-* データ 「解析」
+* データ 「解析」
* データバリデーション
* 自動ドキュメント生成
@@ -128,7 +128,7 @@ http://127.0.0.1:8000/items/foo?short=yes
しかしクエリパラメータを必須にしたい場合は、ただデフォルト値を宣言しなければよいです:
-{* ../../docs_src/query_params/tutorial005_py39.py hl[6:7] *}
+{* ../../docs_src/query_params/tutorial005_py310.py hl[6:7] *}
ここで、クエリパラメータ `needy` は `str` 型の必須のクエリパラメータです。
diff --git a/docs/ja/docs/tutorial/request-files.md b/docs/ja/docs/tutorial/request-files.md
new file mode 100644
index 000000000..538cf6474
--- /dev/null
+++ b/docs/ja/docs/tutorial/request-files.md
@@ -0,0 +1,176 @@
+# リクエストファイル { #request-files }
+
+`File` を使って、クライアントがアップロードするファイルを定義できます。
+
+/// info | 情報
+
+アップロードされたファイルを受け取るには、まず `python-multipart` をインストールします。
+
+[仮想環境](../virtual-environments.md){.internal-link target=_blank}を作成して有効化し、次のようにインストールしてください:
+
+```console
+$ pip install python-multipart
+```
+
+アップロードされたファイルは「form data」として送信されるためです。
+
+///
+
+## `File` をインポート { #import-file }
+
+`fastapi` から `File` と `UploadFile` をインポートします:
+
+{* ../../docs_src/request_files/tutorial001_an_py310.py hl[3] *}
+
+## `File` パラメータの定義 { #define-file-parameters }
+
+`Body` や `Form` と同様の方法でファイルのパラメータを作成します:
+
+{* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *}
+
+/// info | 情報
+
+`File` は `Form` を直接継承したクラスです。
+
+ただし、`fastapi` から `Query`、`Path`、`File` などをインポートするとき、それらは実際には特殊なクラスを返す関数であることに注意してください。
+
+///
+
+/// tip | 豆知識
+
+ファイルのボディを宣言するには `File` を使う必要があります。そうしないと、パラメータはクエリパラメータやボディ(JSON)パラメータとして解釈されます。
+
+///
+
+ファイルは「form data」としてアップロードされます。
+
+*path operation 関数* のパラメータの型を `bytes` として宣言すると、**FastAPI** がファイルを読み取り、内容を `bytes` として受け取ります。
+
+これは内容全体がメモリに保持されることを意味します。小さなファイルには有効です。
+
+しかし、多くの場合は `UploadFile` を使う方が有利です。
+
+## `UploadFile` によるファイルパラメータ { #file-parameters-with-uploadfile }
+
+型を `UploadFile` にしてファイルパラメータを定義します:
+
+{* ../../docs_src/request_files/tutorial001_an_py310.py hl[14] *}
+
+`UploadFile` を使うことには `bytes` に対する次の利点があります:
+
+- パラメータのデフォルト値に `File()` を使う必要がありません。
+- 「spooled」ファイルを使います:
+ - 最大サイズまではメモリに保持し、それを超えるとディスクに格納されるファイルです。
+- そのため、画像・動画・大きなバイナリなどの大きなファイルでも、メモリを使い果たすことなくうまく動作します。
+- アップロードされたファイルからメタデータを取得できます。
+- file-like な `async` インターフェースを持ちます。
+- 実際の Python の `SpooledTemporaryFile` オブジェクトを公開しており、file-like オブジェクトを期待する他のライブラリにそのまま渡せます。
+
+### `UploadFile` { #uploadfile }
+
+`UploadFile` には次の属性があります:
+
+- `filename`: アップロード時の元のファイル名を表す `str`(例: `myimage.jpg`)
+- `content_type`: コンテントタイプ(MIME タイプ / メディアタイプ)を表す `str`(例: `image/jpeg`)
+- `file`: `SpooledTemporaryFile`(file-like なオブジェクト)。これは実際の Python のファイルオブジェクトで、「file-like」オブジェクトを期待する関数やライブラリに直接渡せます。
+
+`UploadFile` には次の `async` メソッドがあります。いずれも内部で対応するファイルメソッド(内部の `SpooledTemporaryFile`)を呼び出します。
+
+- `write(data)`: `data`(`str` または `bytes`)を書き込みます。
+- `read(size)`: `size`(`int`)バイト/文字を読み込みます。
+- `seek(offset)`: ファイル内のバイト位置 `offset`(`int`)に移動します。
+ - 例: `await myfile.seek(0)` はファイルの先頭に移動します。
+ - 一度 `await myfile.read()` を実行して、もう一度内容を読みたい場合に特に便利です。
+- `close()`: ファイルを閉じます。
+
+これらはすべて `async` メソッドなので、`await` する必要があります。
+
+例えば、`async` の *path operation 関数* 内では次のように内容を取得できます:
+
+```Python
+contents = await myfile.read()
+```
+
+通常の `def` の *path operation 関数* 内にいる場合は、`UploadFile.file` に直接アクセスできます。例えば:
+
+```Python
+contents = myfile.file.read()
+```
+
+/// note | `async` の技術詳細
+
+`async` メソッドを使うと、**FastAPI** はファイルメソッドをスレッドプールで実行し、その完了を待機します。
+
+///
+
+/// note | Starlette の技術詳細
+
+**FastAPI** の `UploadFile` は **Starlette** の `UploadFile` を直接継承していますが、**Pydantic** や FastAPI の他の部分と互換にするために必要な要素を追加しています。
+
+///
+
+## 「Form Data」とは { #what-is-form-data }
+
+HTML フォーム(``)がサーバーにデータを送る方法は、そのデータに対して通常「特別な」エンコーディングを用い、JSON とは異なります。
+
+**FastAPI** は JSON ではなく、適切な場所からそのデータを読み取るようにします。
+
+/// note | 技術詳細
+
+ファイルを含まない場合、フォームからのデータは通常「メディアタイプ」`application/x-www-form-urlencoded` でエンコードされます。
+
+ただしフォームにファイルが含まれる場合は、`multipart/form-data` としてエンコードされます。`File` を使うと、**FastAPI** はボディ内の正しい部分からファイルを取得すべきであると認識します。
+
+これらのエンコーディングやフォームフィールドの詳細は、MDN Web Docs の POST を参照してください。
+
+///
+
+/// warning | 注意
+
+1 つの *path operation* に複数の `File` および `Form` パラメータを宣言できますが、同時に JSON として受け取ることを期待する `Body` フィールドを宣言することはできません。リクエストのボディは `application/json` ではなく `multipart/form-data` でエンコードされるためです。
+
+これは **FastAPI** の制限ではなく、HTTP プロトコルの仕様です。
+
+///
+
+## 任意のファイルアップロード { #optional-file-upload }
+
+標準の型アノテーションを使い、デフォルト値を `None` に設定することで、ファイルを任意にできます:
+
+{* ../../docs_src/request_files/tutorial001_02_an_py310.py hl[9,17] *}
+
+## 追加メタデータつきの `UploadFile` { #uploadfile-with-additional-metadata }
+
+例えば追加のメタデータを設定するために、`UploadFile` と併せて `File()` を使うこともできます:
+
+{* ../../docs_src/request_files/tutorial001_03_an_py310.py hl[9,15] *}
+
+## 複数ファイルのアップロード { #multiple-file-uploads }
+
+同時に複数のファイルをアップロードできます。
+
+それらは「form data」で送信される同じ「フォームフィールド」に関連付けられます。
+
+そのためには、`bytes` または `UploadFile` のリストを宣言します:
+
+{* ../../docs_src/request_files/tutorial002_an_py310.py hl[10,15] *}
+
+宣言どおり、`bytes` または `UploadFile` の `list` を受け取ります。
+
+/// note | 技術詳細
+
+`from starlette.responses import HTMLResponse` を使うこともできます。
+
+**FastAPI** は利便性のため、`starlette.responses` と同じものを `fastapi.responses` として提供しています。ただし、利用可能なレスポンスの多くは Starlette から直接提供されています。
+
+///
+
+### 追加メタデータつきの複数ファイルアップロード { #multiple-file-uploads-with-additional-metadata }
+
+先ほどと同様に、`UploadFile` に対しても `File()` を使って追加のパラメータを設定できます:
+
+{* ../../docs_src/request_files/tutorial003_an_py310.py hl[11,18:20] *}
+
+## まとめ { #recap }
+
+リクエストでフォームデータとして送信されるアップロードファイルを宣言するには、`File`、`bytes`、`UploadFile` を使います。
diff --git a/docs/ja/docs/tutorial/request-form-models.md b/docs/ja/docs/tutorial/request-form-models.md
new file mode 100644
index 000000000..071867964
--- /dev/null
+++ b/docs/ja/docs/tutorial/request-form-models.md
@@ -0,0 +1,78 @@
+# フォームモデル { #form-models }
+
+FastAPI では、フォームフィールドを宣言するために Pydantic モデルを使用できます。
+
+/// info | 情報
+
+フォームを使うには、まず `python-multipart` をインストールします。
+
+まず [仮想環境](../virtual-environments.md){.internal-link target=_blank} を作成して有効化し、そのうえでインストールしてください。例えば:
+
+```console
+$ pip install python-multipart
+```
+
+///
+
+/// note | 備考
+
+これは FastAPI バージョン `0.113.0` 以降でサポートされています。🤓
+
+///
+
+## フォーム用の Pydantic モデル { #pydantic-models-for-forms }
+
+受け取りたいフィールドを **フォームフィールド** として持つ **Pydantic モデル** を宣言し、パラメータを `Form` として宣言するだけです:
+
+{* ../../docs_src/request_form_models/tutorial001_an_py310.py hl[9:11,15] *}
+
+**FastAPI** はリクエストの **フォームデータ** から **各フィールド** のデータを **抽出** し、定義した Pydantic モデルとして渡します。
+
+## ドキュメントで確認 { #check-the-docs }
+
+`/docs` のドキュメント UI で確認できます:
+
+
+POSTのウェブドキュメントを参照してください。
+これらのエンコーディングやフォームフィールドの詳細については、MDNのPOSTのウェブドキュメントを参照してください。
///
/// warning | 注意
-*path operation*で複数の`Form`パラメータを宣言することができますが、JSONとして受け取ることを期待している`Body`フィールドを宣言することはできません。なぜなら、リクエストは`application/json`の代わりに`application/x-www-form-urlencoded`を使ってボディをエンコードするからです。
+*path operation*で複数の`Form`パラメータを宣言することができますが、JSONとして受け取ることを期待している`Body`フィールドを宣言することはできません。なぜなら、リクエストは`application/x-www-form-urlencoded`の代わりに`application/json`を使ってボディをエンコードするからです。
これは **FastAPI**の制限ではなく、HTTPプロトコルの一部です。
diff --git a/docs/ja/docs/tutorial/response-model.md b/docs/ja/docs/tutorial/response-model.md
index 258eac8e6..07dc20123 100644
--- a/docs/ja/docs/tutorial/response-model.md
+++ b/docs/ja/docs/tutorial/response-model.md
@@ -41,7 +41,7 @@ FastAPIはこの戻り値の型を使って以下を行います:
/// note | 備考
-`response_model`は「デコレータ」メソッド(`get`、`post`など)のパラメータであることに注意してください。すべてのパラメータやボディのように、*path operation 関数* のパラメータではありません。
+`response_model`は「デコレータ」メソッド(`get`、`post`など)のパラメータです。関数のパラメータやボディなどとは違い、*path operation 関数*のパラメータではありません。
///
@@ -183,7 +183,7 @@ Pydanticフィールドとして有効ではないものを返し、ツール(
最も一般的なケースは、[高度なドキュメントで後述する「Responseを直接返す」](../advanced/response-directly.md){.internal-link target=_blank}場合です。
-{* ../../docs_src/response_model/tutorial003_02_py39.py hl[8,10:11] *}
+{* ../../docs_src/response_model/tutorial003_02_py310.py hl[8,10:11] *}
このシンプルなケースは、戻り値の型アノテーションが `Response` のクラス(またはサブクラス)であるため、FastAPIが自動的に処理します。
@@ -193,7 +193,7 @@ Pydanticフィールドとして有効ではないものを返し、ツール(
型アノテーションで `Response` のサブクラスを使うこともできます:
-{* ../../docs_src/response_model/tutorial003_03_py39.py hl[8:9] *}
+{* ../../docs_src/response_model/tutorial003_03_py310.py hl[8:9] *}
これは `RedirectResponse` が `Response` のサブクラスであり、FastAPIがこのシンプルなケースを自動処理するため、同様に動作します。
@@ -201,7 +201,7 @@ Pydanticフィールドとして有効ではないものを返し、ツール(
しかし、Pydantic型として有効ではない別の任意のオブジェクト(例: データベースオブジェクト)を返し、関数でそのようにアノテーションすると、FastAPIはその型アノテーションからPydanticレスポンスモデルを作成しようとして失敗します。
-同様に、unionのように、複数の型のうち1つ以上がPydantic型として有効でないものを含む場合も起こります。例えば次は失敗します 💥:
+同様に、ユニオンのように、複数の型のうち1つ以上がPydantic型として有効でないものを含む場合も起こります。例えば次は失敗します 💥:
{* ../../docs_src/response_model/tutorial003_04_py310.py hl[8] *}
diff --git a/docs/ja/docs/tutorial/response-status-code.md b/docs/ja/docs/tutorial/response-status-code.md
index d3c219416..d4ac45da6 100644
--- a/docs/ja/docs/tutorial/response-status-code.md
+++ b/docs/ja/docs/tutorial/response-status-code.md
@@ -8,7 +8,7 @@
* `@app.delete()`
* etc.
-{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *}
+{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *}
/// note | 備考
@@ -74,7 +74,7 @@ HTTPでは、レスポンスの一部として3桁の数字のステータスコ
先ほどの例をもう一度見てみましょう:
-{* ../../docs_src/response_status_code/tutorial001_py39.py hl[6] *}
+{* ../../docs_src/response_status_code/tutorial001_py310.py hl[6] *}
`201`は「作成完了」のためのステータスコードです。
@@ -82,7 +82,7 @@ HTTPでは、レスポンスの一部として3桁の数字のステータスコ
`fastapi.status`の便利な変数を利用することができます。
-{* ../../docs_src/response_status_code/tutorial002_py39.py hl[1,6] *}
+{* ../../docs_src/response_status_code/tutorial002_py310.py hl[1,6] *}
それらは単なる便利なものであり、同じ番号を保持しています。しかし、その方法ではエディタの自動補完を使用してそれらを見つけることができます。
diff --git a/docs/ja/docs/tutorial/schema-extra-example.md b/docs/ja/docs/tutorial/schema-extra-example.md
index e526685c2..76a6b0f94 100644
--- a/docs/ja/docs/tutorial/schema-extra-example.md
+++ b/docs/ja/docs/tutorial/schema-extra-example.md
@@ -74,7 +74,7 @@ Pydanticモデルで`Field()`を使う場合、追加の`examples`も宣言で
この場合、examplesはそのボディデータの内部**JSON Schema**の一部になります。
-それでも、執筆時点では、ドキュメントUIの表示を担当するツールであるSwagger UIは、**JSON Schema**内のデータに対して複数の例を表示することをサポートしていません。しかし、回避策については以下を読んでください。
+それでも、執筆時点では、ドキュメントUIの表示を担当するツールであるSwagger UIは、**JSON Schema**内のデータに対して複数の例を表示することをサポートしていません。しかし、回避策については以下を読んでください。
### OpenAPI固有の`examples` { #openapi-specific-examples }
diff --git a/docs/ja/docs/tutorial/security/first-steps.md b/docs/ja/docs/tutorial/security/first-steps.md
index 76ef04db8..5bf04386a 100644
--- a/docs/ja/docs/tutorial/security/first-steps.md
+++ b/docs/ja/docs/tutorial/security/first-steps.md
@@ -20,7 +20,7 @@
`main.py`に、下記の例をコピーします:
-{* ../../docs_src/security/tutorial001_an_py39.py *}
+{* ../../docs_src/security/tutorial001_an_py310.py *}
## 実行 { #run-it }
@@ -132,7 +132,7 @@ OAuth2は、バックエンドやAPIがユーザーを認証するサーバー
`OAuth2PasswordBearer` クラスのインスタンスを作成する時に、パラメーター`tokenUrl`を渡します。このパラメーターには、クライアント (ユーザーのブラウザで動作するフロントエンド) がトークンを取得するために`username`と`password`を送信するURLを指定します。
-{* ../../docs_src/security/tutorial001_an_py39.py hl[8] *}
+{* ../../docs_src/security/tutorial001_an_py310.py hl[8] *}
/// tip | 豆知識
@@ -150,7 +150,7 @@ OAuth2は、バックエンドやAPIがユーザーを認証するサーバー
/// info | 情報
-非常に厳格な「Pythonista」であれば、パラメーター名のスタイルが`token_url`ではなく`tokenUrl`であることを気に入らないかもしれません。
+非常に厳格な「Pythonista」であれば、パラメーター名のスタイルが`tokenUrl`ではなく`token_url`であることを気に入らないかもしれません。
それはOpenAPI仕様と同じ名前を使用しているからです。そのため、これらのセキュリティスキームについてもっと調べる必要がある場合は、それをコピーして貼り付ければ、それについての詳細な情報を見つけることができます。
@@ -170,7 +170,7 @@ oauth2_scheme(some, parameters)
これで`oauth2_scheme`を`Depends`で依存関係に渡すことができます。
-{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *}
+{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *}
この依存関係は、*path operation 関数*のパラメーター`token`に代入される`str`を提供します。
diff --git a/docs/ja/docs/tutorial/security/get-current-user.md b/docs/ja/docs/tutorial/security/get-current-user.md
index 39b97cca5..60378fd98 100644
--- a/docs/ja/docs/tutorial/security/get-current-user.md
+++ b/docs/ja/docs/tutorial/security/get-current-user.md
@@ -2,7 +2,7 @@
一つ前の章では、(依存性注入システムに基づいた)セキュリティシステムは、 *path operation 関数* に `str` として `token` を与えていました:
-{* ../../docs_src/security/tutorial001_an_py39.py hl[12] *}
+{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *}
しかし、それはまだそんなに有用ではありません。
diff --git a/docs/ja/docs/tutorial/security/index.md b/docs/ja/docs/tutorial/security/index.md
index 14f2c8f44..b96021b7f 100644
--- a/docs/ja/docs/tutorial/security/index.md
+++ b/docs/ja/docs/tutorial/security/index.md
@@ -1,4 +1,4 @@
-# セキュリティ入門
+# セキュリティ入門 { #security }
セキュリティ、認証、認可を扱うには多くの方法があります。
@@ -10,11 +10,11 @@
しかし、その前に、いくつかの小さな概念を確認しましょう。
-## お急ぎですか?
+## お急ぎですか? { #in-a-hurry }
もし、これらの用語に興味がなく、ユーザー名とパスワードに基づく認証でセキュリティを**今すぐ**確保する必要がある場合は、次の章に進んでください。
-## OAuth2
+## OAuth2 { #oauth2 }
OAuth2は、認証と認可を処理するためのいくつかの方法を定義した仕様です。
@@ -24,7 +24,7 @@ OAuth2は、認証と認可を処理するためのいくつかの方法を定
これが、「Facebook、Google、X (Twitter)、GitHubを使ってログイン」を使用したすべてのシステムの背後で使われている仕組みです。
-### OAuth 1
+### OAuth 1 { #oauth-1 }
OAuth 1というものもありましたが、これはOAuth2とは全く異なり、通信をどのように暗号化するかという仕様が直接的に含まれており、より複雑なものとなっています。
@@ -38,7 +38,7 @@ OAuth2は、通信を暗号化する方法を指定せず、アプリケーシ
///
-## OpenID Connect
+## OpenID Connect { #openid-connect }
OpenID Connectは、**OAuth2**をベースにした別の仕様です。
@@ -48,7 +48,7 @@ OpenID Connectは、**OAuth2**をベースにした別の仕様です。
しかし、FacebookのログインはOpenID Connectをサポートしていません。OAuth2を独自にアレンジしています。
-### OpenID (「OpenID Connect」ではない)
+### OpenID (「OpenID Connect」ではない) { #openid-not-openid-connect }
また、「OpenID」という仕様もありました。それは、**OpenID Connect**と同じことを解決しようとしたものですが、OAuth2に基づいているわけではありませんでした。
@@ -56,7 +56,7 @@ OpenID Connectは、**OAuth2**をベースにした別の仕様です。
現在ではあまり普及していませんし、使われてもいません。
-## OpenAPI
+## OpenAPI { #openapi }
OpenAPI(以前はSwaggerとして知られていました)は、APIを構築するためのオープンな仕様です(現在はLinux Foundationの一部になっています)。
@@ -97,7 +97,7 @@ Google、Facebook、X (Twitter)、GitHubなど、他の認証/認可プロバイ
///
-## **FastAPI** ユーティリティ
+## **FastAPI** ユーティリティ { #fastapi-utilities }
FastAPIは `fastapi.security` モジュールの中で、これらのセキュリティスキームごとにいくつかのツールを提供し、これらのセキュリティメカニズムを簡単に使用できるようにします。
diff --git a/docs/ja/docs/tutorial/security/oauth2-jwt.md b/docs/ja/docs/tutorial/security/oauth2-jwt.md
index 186936f1b..0d6be90a2 100644
--- a/docs/ja/docs/tutorial/security/oauth2-jwt.md
+++ b/docs/ja/docs/tutorial/security/oauth2-jwt.md
@@ -1,6 +1,6 @@
# パスワード(およびハッシュ化)によるOAuth2、JWTトークンによるBearer { #oauth2-with-password-and-hashing-bearer-with-jwt-tokens }
-これでセキュリティの流れが全てわかったので、JWTトークンと安全なパスワードのハッシュ化を使用して、実際にアプリケーションを安全にしてみましょう。
+これでセキュリティの流れが全てわかったので、JWTトークンと安全なパスワードのハッシュ化を使用して、実際にアプリケーションを安全にしてみましょう。
このコードは、アプリケーションで実際に使用したり、パスワードハッシュをデータベースに保存するといった用途に利用できます。
@@ -116,7 +116,11 @@ pwdlibはbcryptハッシュアルゴリズムもサポートしていますが
さらに、ユーザーを認証して返す関数も作成します。
-{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,56:57,60:61,70:76] *}
+{* ../../docs_src/security/tutorial004_an_py310.py hl[8,49,51,58:59,62:63,72:79] *}
+
+`authenticate_user` がデータベースに存在しないユーザー名で呼び出された場合でも、ダミーのハッシュを使って `verify_password` を実行します。
+
+これにより、ユーザー名が有効かどうかに関わらずエンドポイントの応答時間がおおよそ同じになり、既存のユーザー名を列挙するために悪用されうる「タイミング攻撃」を防止できます。
/// note | 備考
@@ -152,7 +156,7 @@ JWTトークンの署名に使用するアルゴリズム`"HS256"`を指定し
新しいアクセストークンを生成するユーティリティ関数を作成します。
-{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,79:87] *}
+{* ../../docs_src/security/tutorial004_an_py310.py hl[4,7,13:15,29:31,82:90] *}
## 依存関係の更新 { #update-the-dependencies }
@@ -162,7 +166,7 @@ JWTトークンの署名に使用するアルゴリズム`"HS256"`を指定し
トークンが無効な場合は、すぐにHTTPエラーを返します。
-{* ../../docs_src/security/tutorial004_an_py310.py hl[90:107] *}
+{* ../../docs_src/security/tutorial004_an_py310.py hl[93:110] *}
## `/token` *path operation* の更新 { #update-the-token-path-operation }
@@ -170,7 +174,7 @@ JWTトークンの署名に使用するアルゴリズム`"HS256"`を指定し
実際のJWTアクセストークンを作成し、それを返します。
-{* ../../docs_src/security/tutorial004_an_py310.py hl[118:133] *}
+{* ../../docs_src/security/tutorial004_an_py310.py hl[121:136] *}
### JWTの「subject」`sub` についての技術的な詳細 { #technical-details-about-the-jwt-subject-sub }
diff --git a/docs/ja/docs/tutorial/security/simple-oauth2.md b/docs/ja/docs/tutorial/security/simple-oauth2.md
new file mode 100644
index 000000000..c371b0acf
--- /dev/null
+++ b/docs/ja/docs/tutorial/security/simple-oauth2.md
@@ -0,0 +1,289 @@
+# パスワードとBearerによるシンプルなOAuth2 { #simple-oauth2-with-password-and-bearer }
+
+前章から発展させて、完全なセキュリティフローに必要な不足部分を追加していきます。
+
+## `username` と `password` を取得する { #get-the-username-and-password }
+
+`username` と `password` を取得するために **FastAPI** のセキュリティユーティリティを使います。
+
+OAuth2 では、「password flow」(ここで使用するフロー)を使う場合、クライアント/ユーザーはフォームデータとして `username` と `password` フィールドを送信する必要があります。
+
+しかも、フィールド名はこの通りでなければなりません。つまり、`user-name` や `email` では動作しません。
+
+ただし、フロントエンドで最終ユーザーにどう表示するかは自由です。
+
+また、データベースのモデルでは任意の別名を使って構いません。
+
+しかし、ログイン用の path operation では、仕様との互換性を保つ(たとえば組み込みのAPIドキュメントシステムを使えるようにする)ために、これらの名前を使う必要があります。
+
+また、仕様では `username` と `password` はフォームデータとして送らなければならない(つまり、ここではJSONは使わない)ことも定められています。
+
+### `scope` { #scope }
+
+仕様では、クライアントは追加のフォームフィールド「`scope`」を送ることができるとも書かれています。
+
+フォームフィールド名は `scope`(単数形)ですが、実態はスペース区切りの「スコープ」文字列を並べた長い文字列です。
+
+各「スコープ」は(スペースを含まない)単なる文字列です。
+
+通常、特定のセキュリティ権限を宣言するために使われます。例えば:
+
+- `users:read` や `users:write` はよくある例です。
+- `instagram_basic` は Facebook / Instagram で使われます。
+- `https://www.googleapis.com/auth/drive` は Google で使われます。
+
+/// info | 情報
+
+OAuth2 における「スコープ」は、要求される特定の権限を表す単なる文字列です。
+
+`:` のような他の文字を含んでいても、URL であっても構いません。
+
+それらの詳細は実装依存です。
+
+OAuth2 にとっては単なる文字列です。
+
+///
+
+## `username` と `password` を取得するコード { #code-to-get-the-username-and-password }
+
+では、これを処理するために **FastAPI** が提供するユーティリティを使いましょう。
+
+### `OAuth2PasswordRequestForm` { #oauth2passwordrequestform }
+
+まず、`OAuth2PasswordRequestForm` をインポートし、`/token` の path operation に `Depends` で依存関係として使います:
+
+{* ../../docs_src/security/tutorial003_an_py310.py hl[4,78] *}
+
+`OAuth2PasswordRequestForm` は次のフォームボディを宣言するクラス依存関係です:
+
+- `username`
+- `password`
+- スペース区切りの文字列で構成される、オプションの `scope` フィールド
+- オプションの `grant_type`
+
+/// tip | 豆知識
+
+OAuth2 の仕様では、固定値 `password` を持つフィールド `grant_type` が実際には必須ですが、`OAuth2PasswordRequestForm` はそれを強制しません。
+
+強制したい場合は、`OAuth2PasswordRequestForm` の代わりに `OAuth2PasswordRequestFormStrict` を使ってください。
+
+///
+
+- オプションの `client_id`(この例では不要)
+- オプションの `client_secret`(この例では不要)
+
+/// info | 情報
+
+`OAuth2PasswordRequestForm` は、`OAuth2PasswordBearer` のように **FastAPI** にとって特別なクラスではありません。
+
+`OAuth2PasswordBearer` は **FastAPI** にセキュリティスキームであることを認識させます。そのため OpenAPI にそのように追加されます。
+
+一方、`OAuth2PasswordRequestForm` は、あなた自身でも書けるような単なるクラス依存関係であり、直接 `Form` パラメータを宣言することもできます。
+
+ただし一般的なユースケースなので、簡単に使えるよう **FastAPI** が直接提供しています。
+
+///
+
+### フォームデータの利用 { #use-the-form-data }
+
+/// tip | 豆知識
+
+依存関係クラス `OAuth2PasswordRequestForm` のインスタンスは、スペース区切りの長い文字列を持つ `scope` 属性は持ちません。代わりに、送られてきた各スコープの実際の文字列リストを格納する `scopes` 属性を持ちます。
+
+この例では `scopes` は使いませんが、必要ならその機能が利用できます。
+
+///
+
+次に、フォームフィールドの `username` を使って(疑似の)データベースからユーザーデータを取得します。
+
+そのユーザーが存在しない場合は、「Incorrect username or password」というエラーを返します。
+
+エラーには `HTTPException` 例外を使います:
+
+{* ../../docs_src/security/tutorial003_an_py310.py hl[3,79:81] *}
+
+### パスワードのチェック { #check-the-password }
+
+この時点でデータベースからユーザーデータは取得できましたが、まだパスワードを確認していません。
+
+まず、そのデータを Pydantic の `UserInDB` モデルに入れます。
+
+プレーンテキストのパスワードを保存してはいけないので、(疑似の)パスワードハッシュ化システムを使います。
+
+パスワードが一致しなければ、同じエラーを返します。
+
+#### パスワードハッシュ化 { #password-hashing }
+
+「ハッシュ化」とは、ある内容(ここではパスワード)を、乱雑に見えるバイト列(単なる文字列)に変換することを指します。
+
+まったく同じ内容(まったく同じパスワード)を渡すと、毎回まったく同じ乱雑な文字列が得られます。
+
+しかし、その乱雑な文字列から元のパスワードに戻すことはできません。
+
+##### なぜパスワードをハッシュ化するのか { #why-use-password-hashing }
+
+もしデータベースが盗まれても、盗んだ側が手にするのはユーザーのプレーンテキストのパスワードではなく、ハッシュだけです。
+
+したがって、盗んだ側は同じパスワードを別のシステムで試すことができません(多くのユーザーがあらゆる場所で同じパスワードを使っているため、これは危険になり得ます)。
+
+{* ../../docs_src/security/tutorial003_an_py310.py hl[82:85] *}
+
+#### `**user_dict` について { #about-user-dict }
+
+`UserInDB(**user_dict)` は次を意味します:
+
+`user_dict` のキーと値を、そのままキーワード引数として渡します。つまり次と同等です:
+
+```Python
+UserInDB(
+ username = user_dict["username"],
+ email = user_dict["email"],
+ full_name = user_dict["full_name"],
+ disabled = user_dict["disabled"],
+ hashed_password = user_dict["hashed_password"],
+)
+```
+
+/// info | 情報
+
+`**user_dict` のより完全な解説は、[**追加モデル**のドキュメント](../extra-models.md#about-user-in-dict){.internal-link target=_blank}を参照してください。
+
+///
+
+## トークンを返す { #return-the-token }
+
+`token` エンドポイントのレスポンスは JSON オブジェクトでなければなりません。
+
+`token_type` を含める必要があります。ここでは「Bearer」トークンを使うので、トークンタイプは「`bearer`」です。
+
+そして `access_token` を含め、その中にアクセストークンの文字列を入れます。
+
+この単純な例では、完全に安全ではありませんが、トークンとして同じ `username` をそのまま返します。
+
+/// tip | 豆知識
+
+次の章では、パスワードハッシュ化と JWT トークンを使った本当に安全な実装を見ます。
+
+しかし今は、必要な特定の詳細に集中しましょう。
+
+///
+
+{* ../../docs_src/security/tutorial003_an_py310.py hl[87] *}
+
+/// tip | 豆知識
+
+仕様に従うと、この例と同じく `access_token` と `token_type` を含む JSON を返す必要があります。
+
+これはあなた自身のコードで実装する必要があり、これらのJSONキーを使っていることを確認してください。
+
+仕様に準拠するために、あなた自身が正しく覚えて実装すべきことは、ほぼこれだけです。
+
+それ以外は **FastAPI** が面倒を見てくれます。
+
+///
+
+## 依存関係の更新 { #update-the-dependencies }
+
+ここで依存関係を更新します。
+
+アクティブなユーザーの場合にのみ `current_user` を取得したいとします。
+
+そこで、`get_current_user` を依存関係として利用する追加の依存関係 `get_current_active_user` を作成します。
+
+これら2つの依存関係は、ユーザーが存在しない、または非アクティブである場合に、HTTPエラーを返すだけです。
+
+したがって、エンドポイントでは、ユーザーが存在し、正しく認証され、かつアクティブである場合にのみ、ユーザーを取得します:
+
+{* ../../docs_src/security/tutorial003_an_py310.py hl[58:66,69:74,94] *}
+
+/// info | 情報
+
+ここで返している値が `Bearer` の追加ヘッダー `WWW-Authenticate` も仕様の一部です。
+
+HTTP(エラー)ステータスコード 401「UNAUTHORIZED」は、`WWW-Authenticate` ヘッダーも返すことになっています。
+
+ベアラートークン(今回のケース)の場合、そのヘッダーの値は `Bearer` であるべきです。
+
+実際のところ、この追加ヘッダーを省略しても動作はします。
+
+しかし、仕様に準拠するためにここでは付与しています。
+
+また、(今または将来)それを想定して利用するツールがあるかもしれず、あなたやユーザーにとって有用になる可能性があります。
+
+これが標準の利点です…。
+
+///
+
+## 動作確認 { #see-it-in-action }
+
+インタラクティブドキュメントを開きます: http://127.0.0.1:8000/docs。
+
+### 認証 { #authenticate }
+
+「Authorize」ボタンをクリックします。
+
+次の認証情報を使います:
+
+User: `johndoe`
+
+Password: `secret`
+
+
+
+システムで認証されると、次のように表示されます:
+
+
+
+### 自分のユーザーデータを取得 { #get-your-own-user-data }
+
+`GET` の path `/users/me` を使います。
+
+次のようなユーザーデータが取得できます:
+
+```JSON
+{
+ "username": "johndoe",
+ "email": "johndoe@example.com",
+ "full_name": "John Doe",
+ "disabled": false,
+ "hashed_password": "fakehashedsecret"
+}
+```
+
+
+
+錠前アイコンをクリックしてログアウトし、同じ操作を再度試すと、次のような HTTP 401 エラーになります:
+
+```JSON
+{
+ "detail": "Not authenticated"
+}
+```
+
+### 非アクティブユーザー { #inactive-user }
+
+今度は非アクティブなユーザーで試してみます。次で認証してください:
+
+User: `alice`
+
+Password: `secret2`
+
+そして `GET` の path `/users/me` を使います。
+
+次のような「Inactive user」エラーになります:
+
+```JSON
+{
+ "detail": "Inactive user"
+}
+```
+
+## まとめ { #recap }
+
+これで、API のために `username` と `password` に基づく完全なセキュリティシステムを実装するための道具が揃いました。
+
+これらの道具を使えば、任意のデータベース、任意のユーザー/データモデルと互換性のあるセキュリティシステムを構築できます。
+
+ただし、実際にはまだ「安全」ではありません。
+
+次の章では、安全なパスワードハッシュライブラリと JWT トークンの使い方を見ていきます。
diff --git a/docs/ja/docs/tutorial/sql-databases.md b/docs/ja/docs/tutorial/sql-databases.md
new file mode 100644
index 000000000..930e433de
--- /dev/null
+++ b/docs/ja/docs/tutorial/sql-databases.md
@@ -0,0 +1,357 @@
+# SQL(リレーショナル)データベース { #sql-relational-databases }
+
+FastAPI は SQL(リレーショナル)データベースの使用を必須にはしません。必要であれば、任意のデータベースを使用できます。
+
+ここでは SQLModel を使った例を見ていきます。
+
+SQLModel は SQLAlchemy と Pydantic の上に構築されています。FastAPI と同じ作者により、SQL データベースを使う必要がある FastAPI アプリに最適になるように作られています。
+
+/// tip | 豆知識
+
+他の任意の SQL あるいは NoSQL のデータベースライブラリ(場合によっては "ORMs" と呼ばれます)を使うこともできます。FastAPI は何も強制しません。😎
+
+///
+
+SQLModel は SQLAlchemy をベースにしているため、SQLAlchemy がサポートする任意のデータベース(SQLModel からもサポートされます)を簡単に使えます。例えば:
+
+* PostgreSQL
+* MySQL
+* SQLite
+* Oracle
+* Microsoft SQL Server など
+
+この例では、単一ファイルで動作し、Python に統合サポートがあるため、SQLite を使います。つまり、この例をそのままコピーして実行できます。
+
+本番アプリでは、PostgreSQL のようなデータベースサーバーを使いたくなるかもしれません。
+
+/// tip | 豆知識
+
+フロントエンドやその他のツールを含む、FastAPI と PostgreSQL の公式プロジェクトジェネレーターがあります: https://github.com/fastapi/full-stack-fastapi-template
+
+///
+
+これはとてもシンプルで短いチュートリアルです。データベースや SQL、より高度な機能について学びたい場合は、SQLModel のドキュメントをご覧ください。
+
+## `SQLModel` のインストール { #install-sqlmodel }
+
+まずは [仮想環境](../virtual-environments.md){.internal-link target=_blank} を作成・有効化し、`sqlmodel` をインストールします:
+
+
+
+