From 5828043b69e566ddf89f1f49aa07d69411813961 Mon Sep 17 00:00:00 2001 From: "T. Tokusumi" <41147016+tokusumi@users.noreply.github.com> Date: Mon, 8 Feb 2021 02:23:55 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=90=20Add=20Japanese=20translation=20f?= =?UTF-8?q?or=20Tutorial=20-=20Middleware=20(#2255)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sho Nakamura --- docs/ja/docs/tutorial/middleware.md | 61 +++++++++++++++++++++++++++++ docs/ja/mkdocs.yml | 1 + 2 files changed, 62 insertions(+) create mode 100644 docs/ja/docs/tutorial/middleware.md diff --git a/docs/ja/docs/tutorial/middleware.md b/docs/ja/docs/tutorial/middleware.md new file mode 100644 index 000000000..f2a22119b --- /dev/null +++ b/docs/ja/docs/tutorial/middleware.md @@ -0,0 +1,61 @@ +# ミドルウェア + +**FastAPI** アプリケーションにミドルウェアを追加できます。 + +「ミドルウェア」は、すべての**リクエスト**に対して、それがあらゆる特定の*path operation*によって処理される前に機能する関数です。また、すべての**レスポンス**に対して、それを返す前に機能します。 + +* ミドルウェアはアプリケーションに届いたそれぞれの**リクエスト**を受け取ります。 +* その後、その**リクエスト**に対して何かを実行したり、必要なコードを実行したりできます。 +* 次に、アプリケーションの残りの部分に**リクエスト**を渡して (*path operation* によって) 処理させます。 +* 次に、ミドルウェアはアプリケーション (の *path operation*) によって生成された**レスポンス**を受け取ります。 +* その**レスポンス**に対して何かを実行したり、必要なコードを実行したりできます。 +* そして、**レスポンス**を返します。 + +!!! note "技術詳細" + `yield` を使った依存関係をもつ場合は、終了コードはミドルウェアの *後に* 実行されます。 + + バックグラウンドタスク (後述) がある場合は、それらは全てのミドルウェアの *後に* 実行されます。 + +## ミドルウェアの作成 + +ミドルウェアを作成するには、関数の上部でデコレータ `@app.middleware("http")` を使用します。 + +ミドルウェア関数は以下を受け取ります: + +* `request`。 +* パラメータとして `request` を受け取る関数 `call_next`。 + * この関数は、対応する*path operation*に `request` を渡します。 + * 次に、対応する*path operation*によって生成された `response` を返します。 +* その後、`response` を返す前にさらに `response` を変更することもできます。 + +```Python hl_lines="8-9 11 14" +{!../../../docs_src/middleware/tutorial001.py!} +``` + +!!! tip "豆知識" + 'X-'プレフィックスを使用してカスタムの独自ヘッダーを追加できます。 + + ただし、ブラウザのクライアントに表示させたいカスタムヘッダーがある場合は、StarletteのCORSドキュメントに記載されているパラメータ `expose_headers` を使用して、それらをCORS設定に追加する必要があります ([CORS (オリジン間リソース共有)](cors.md){.internal-link target=_blank}) + +!!! note "技術詳細" + `from starlette.requests import Request` を使用することもできます。 + + **FastAPI**は、開発者の便利のためにこれを提供していますが、Starletteから直接きています。 + +### `response` の前後 + +*path operation* が `request` を受け取る前に、 `request` とともに実行されるコードを追加できます。 + +また `response` が生成された後、それを返す前にも追加できます。 + +例えば、リクエストの処理とレスポンスの生成にかかった秒数を含むカスタムヘッダー `X-Process-Time` を追加できます: + +```Python hl_lines="10 12-13" +{!../../../docs_src/middleware/tutorial001.py!} +``` + +## その他のミドルウェア + +他のミドルウェアの詳細については、[高度なユーザーガイド: 高度なミドルウェア](../advanced/middleware.md){.internal-link target=_blank}を参照してください。 + +次のセクションでは、ミドルウェアを使用して CORS を処理する方法について説明します。 diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml index a85d12e2b..b9c5154f7 100644 --- a/docs/ja/mkdocs.yml +++ b/docs/ja/mkdocs.yml @@ -65,6 +65,7 @@ nav: - tutorial/body-updates.md - セキュリティ: - tutorial/security/first-steps.md + - tutorial/middleware.md - tutorial/cors.md - 高度なユーザーガイド: - advanced/path-operation-advanced-configuration.md