Search Result: レスポンス

Results of 1 - 10 of about 29 for レスポンス (0.002 sec.)

カスタムレスポンス - HTML、ストリーム、ファイル、その他のレスポンス 13901: カスタムレスポンス - HTML、ストリーム、ファイル、その他のレスポンス デフォルトでは、 FastAPI は JSONResponse を使ってレスポンスを返します。 レスポンスを直接返すで見たように、 Response を直接返すことでこの挙動をオーバーライドできます。しか ... デコレータに宣言したPydantic response_model により自動的に変換 (もしくはフィルタ) されます。備考メディアタイプを指定せずにレスポンスクラスを利用すると、FastAPIは何もコンテンツがないことを期待します。そのため、生成されるOpenAPIドキュメントにレスポンスフォー ... が記載されません。 ORJSONResponse を使う例えば、パフォーマンスを出したい場合は、 orjson をインストールし、 ORJSONResponse をレスポンスとしてセットすることができます。使いたい Response クラス (サブクラス) をインポートし、 path operationデコレータに宣言します ... JSONResponse ) async def read_items (): return ORJSONResponse ([{ "item_id" : "Foo" }]) 情報パラメータ response_class は、レスポンスの「メディアタイプ」を定義するために利用することもできます。この場合、HTTPヘッダー Content-Type には application/json がセッ ...; https://man.mtool.work/fastapi/0.115/advanced/custom-response/

レスポンスステータスコード 12073: レスポンスステータスコード レスポンスモデルを指定するのと同じ方法で、レスポンスに使用されるHTTPステータスコードを以下の path operations のいずれかの status_code パラメータで宣言することもできます。 @app.get() @app.post() @app.put() @app.del ... を受け取ります。情報 status_code は代わりに、Pythonの http.HTTPStatus のように、 IntEnum を受け取ることもできます。これは: レスポンスでステータスコードを返します。 OpenAPIスキーマ（およびユーザーインターフェース）に以下のように文書化します: 備考いくつかのレ ... スポンスコード（次のセクションを参照）は、レスポンスにボディがないことを示しています。 FastAPIはこれを知っていて、レスポンスボディがないというOpenAPIドキュメントを生成します。 ... ードについて備考すでにHTTPステータスコードが何であるかを知っている場合は、次のセクションにスキップしてください。 HTTPでは、レスポンスの一部として3桁の数字のステータスコードを送信します。これらのステータスコードは、それらを認識するために関連付けられた名前を ...; https://man.mtool.work/fastapi/0.115/tutorial/response-status-code/

HTTPS について 10001: HTTPS について HTTPSは単に「有効」か「無効」かで決まるものだと思いがちです。しかし、それよりもはるかに複雑です。 Tip もし急いでいたり、HTTPSの仕組みについて気にしないのであれば、次のセクションに進み、さまざまなテクニックを使ってすべてをセッ ... ーバーで実行されている実際の HTTP アプリケーション（この場合は FastAPI アプリケーション）に送信し、アプリケーションから HTTP レスポンス を受け取り、適切な HTTPS 証明書を使用して暗号化し、そして HTTPS を使用してクライアントに送り返します。このサーバーはし ... ケーションを実行しているプロセス (例えば、FastAPI アプリケーションを実行している Uvicorn を持つプロセス) に送信します。 HTTP レスポンス アプリケーションはリクエストを処理し、プレーン(暗号化されていない)HTTPレスポンスをTLS Termination Proxyに送信します。 HT ... TPS レスポンス TLS Termination Proxyは次に、事前に合意が取れている暗号( someapp.example.com の証明書から始まる)を使って レスポンスを暗号化 ...; https://man.mtool.work/fastapi/0.115/deployment/https/

レスポンスモデル 9397: レスポンスモデル path operations のいずれにおいても、 response_model パラメータを使用して、レスポンスのモデルを宣言することができます: @app.get() @app.post() @app.put() @app.delete() など。 Python 3.8+ from typing import Any , List , Union ... ponse_model を使って以下のことをします: 出力データを型宣言に変換します。データを検証します。 OpenAPIの path operation で、レスポンス用のJSON Schemaを追加します。自動ドキュメントシステムで使用されます。しかし、最も重要なのは: 出力データをモデルのデータに限 ... 定します。これがどのように重要なのか以下で見ていきましょう。技術詳細 レスポンスモデルは、関数の戻り値のアノテーションではなく、このパラメータで宣言されています。なぜなら、パス関数は実際にはそのレスポンス ... def create_user ( user : UserIn ) -> UserIn : return user これで、ブラウザがパスワードを使ってユーザーを作成する際に、APIがレスポンスで同じパスワードを返すようになりました。この場合、ユーザー自身がパスワードを送信しているので問題ないかもしれません。しかし ...; https://man.mtool.work/fastapi/0.115/tutorial/response-model/

yieldを持つ依存関係 9332: yieldを持つ依存関係 FastAPIは、いくつかの終了後の追加のステップを行う依存関係をサポートしています。これを行うには、 return の代わりに yield を使い、その後に追加のステップを書きます。豆知識 yield は必ず一度だけ使用するようにしてください。 ... ield を持つデータベースの依存関係例えば、これを使ってデータベースセッションを作成し、終了後にそれを閉じることができます。 レスポンスを送信する前に yield 文を含む前のコードのみが実行されます。 Python 3.8+ async def get_db (): db = DBSession () try : yield d ... ものです: Python 3.8+ async def get_db (): db = DBSession () try : yield db finally : db . close () yield 文に続くコードは、レスポンスが送信された後に実行されます: Python 3.8+ async def get_db (): db = DBSession () try : yield db finally : db . close () 豆知 ... チするものはなにもありません。つまり、 yield の後に HTTPException を発生させた場合、 HTTTPException をキャッチしてHTTP 400のレスポンスを返すデフォルトの（あるいは任意のカスタムの）例外ハンドラは、その例外をキャッチすることができなくなります。これは、依存関係 ...; https://man.mtool.work/fastapi/0.115/tutorial/dependencies/dependencies-with-yie...

追加データ型 9332: 追加データ型今までは、以下のような一般的なデータ型を使用してきました: int float str bool しかし、より複雑なデータ型を使用することもできます。そして、今まで見てきたのと同じ機能を持つことになります: 素晴らしいエディタのサポート受信したリク ... エストからのデータ変換 レスポンスデータのデータ変換データの検証自動注釈と文書化他のデータ型ここでは、使用できる追加のデータ型のいくつかを紹介します: UUID ... : 多くのデータベースやシステムで共通のIDとして使用される、標準的な「ユニバーサルにユニークな識別子」です。リクエストとレスポンスでは str として表現されます。 datetime.datetime : Pythonの datetime.datetime です。リクエストとレスポンスはISO 8601形式の s ... tr で表現されます: 2008-09-15T15:53:00+05:00 datetime.date : Pythonの datetime.date です。リクエストとレスポンスはISO 8601形式の str で表現されます: 2008-09-15 datetime.time : Pythonの datetime.time . リクエストとレスポンスはISO 8601形式 ...; https://man.mtool.work/fastapi/0.115/tutorial/extra-data-types/

レスポンスを直接返す 9055: レスポンスを直接返す FastAPI の path operation では、通常は任意のデータを返すことができます: 例えば、 dict 、 list 、Pydanticモデル、データベースモデルなどです。デフォルトでは、 FastAPI は JSON互換エンコーダで説明されている jsonable_encod ... r により、返す値を自動的にJSONに変換します。このとき背後では、JSON互換なデータ (例えば dict ) を、クライアントへ送信されるレスポンスとして利用される JSONResponse の中に含めます。しかし、 path operation から JSONResponse を直接返すこともできます。これは例 ... すべてのデータ型 ( datetime や UUID など) をJSON互換の型に変換された dict に変換しなければなりません。このようなケースでは、レスポンスにデータを含める前に jsonable_encoder を使ってデータを変換できます。 Python 3.8+ from datetime import datetime from typing i ... astAPI は開発者の利便性のために fastapi.responses という starlette.responses と同じものを提供しています。しかし、利用可能なレスポンスのほとんどはStarletteから直接提供されます。カスタム Response を返す上記の例では必要な部分を全て示していますが、あまり便利で ...; https://man.mtool.work/fastapi/0.115/advanced/response-directly/

エラーハンドリング 8843: エラーハンドリング APIを使用しているクライアントにエラーを通知する必要がある状況はたくさんあります。このクライアントは、フロントエンドを持つブラウザ、誰かのコード、IoTデバイスなどが考えられます。クライアントに以下のようなことを伝える必要が ... からのエラーがあったことを意味します。 "404 Not Found" のエラー（およびジョーク）を覚えていますか? HTTPException の使用 HTTPレスポンスをエラーでクライアントに返すには、 HTTPException を使用します。 HTTPException のインポート Python 3.8+ from fastapi import F ... not in items : raise HTTPException ( status_code = 404 , detail = "Item not found" ) return { "item" : items [ item_id ]} レスポンス結果クライアントが http://example.com/items/foo （ item_id "foo" ）をリクエストすると、HTTPステータスコードが200で、以下のJ ... SONレスポンスが返されます: { "item" : "The Foo Wrestlers" } しかし、クライアントが http://example.com/items/bar （存在しない item_id "bar ...; https://man.mtool.work/fastapi/0.115/tutorial/handling-errors/

ミドルウェア 8679: ミドルウェア FastAPI アプリケーションにミドルウェアを追加できます。「ミドルウェア」は、すべてのリクエストに対して、それがあらゆる特定の path operation によって処理される前に機能する関数です。また、すべての レスポンス に対して、それを返す ... して ( path operation によって) 処理させます。次に、ミドルウェアはアプリケーション (の path operation ) によって生成された レスポンス を受け取ります。その レスポンス に対して何かを実行したり、必要なコードを実行したりできます。そして、 レスポンス を返しま ... もに実行されるコードを追加できます。また response が生成された後、それを返す前にも追加できます。例えば、リクエストの処理とレスポンスの生成にかかった秒数を含むカスタムヘッダー X-Process-Time を追加できます: Python 3.8+ import time from fastapi import FastAP ...; https://man.mtool.work/fastapi/0.115/tutorial/middleware/

Path Operationの設定 8679: Path Operationの設定 path operationデコレータを設定するためのパラメータがいくつかあります。注意これらのパラメータは path operation関数ではなく、 path operationデコレータに直接渡されることに注意してください。 レスポンスステータスコード ... path operation のレスポンスで使用する（HTTP） status_code を定義することができます。 404 のように int のコードを直接渡すことができます。しかし、それぞ ... Item , status_code = status . HTTP_201_CREATED ) async def create_item ( item : Item ): return item そのステータスコードはレスポンスで使用され、OpenAPIスキーマに追加されます。技術詳細また、 from starlette import status を使用することもできます。 FastAPI ... an omit this - **tags**: a set of unique tag strings for this item """ return item これは対話的ドキュメントで使用されます: レスポンスの説明 response_description パラメータでレスポンスの説明をすることができます。 Python 3.8+ from typing import Set , Union fr ...; https://man.mtool.work/fastapi/0.115/tutorial/path-operation-configuration/

PREV 1 2 3 NEXT