実行する

次のようにサーバーを実行します。

$ uvicorn main:app --reload

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [28720]
INFO:     Started server process [28722]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

uvicorn main:app --reload

uvicorn main:app

確認する

http://127.0.0.1:8000/items/5?q=somequery でブラウザを開きます。

JSON 応答は次のように表示されます。

{"item_id": 5, "q": "somequery"}

次のような API が既に作成されています。

• パスで HTTP 要求を受信します。

  /

  /items/{item_id}

• どちらのパスも操作(HTTPメソッドとも呼ばれます)を取ります。

  GET

• パスには、次のパス パラメーターが必要です。

  /items/{item_id}

  item_id

  int

• パスには、オプションのクエリ パラメーターがあります。

  /items/{item_id}

  str

  q

対話型 API ドキュメント

次に、http://127.0.0.1:8000/docs に移動します。

自動インタラクティブAPIドキュメント(Swagger UIで提供)が表示されます。

代替 API ドキュメント

そして今、http://127.0.0.1:8000/redoc に行きます。

代替の自動ドキュメント(ReDoc提供)が表示されます。

アップグレードの例

次に、ファイルを変更しますから本文を受信するリクエスト。

main.py

PUT

Pydanticのおかげで、標準のPython型を使用して本文を宣言します。

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: Union[bool, None] = None


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_name": item.name, "item_id": item_id}

サーバーは自動的にリロードする必要があります(追加したため上記のコマンド)。

--reload

uvicorn

対話型 API ドキュメントのアップグレード

次に、http://127.0.0.1:8000/docs に移動します。

• インタラクティブな API ドキュメントは、新しい本文を含めて自動的に更新されます。

• 「試してみる」ボタンをクリックすると、パラメータを入力してAPIと直接対話できます。

• 次に、[実行]ボタンをクリックすると、ユーザーインターフェイスがAPIと通信し、パラメーターを送信し、結果を取得して画面に表示します。

代替 API ドキュメントのアップグレード

そして今、http://127.0.0.1:8000/redoc に行きます。

• 代替ドキュメントには、新しいクエリ パラメーターと本文も反映されます。

要約

要約すると、パラメータの型、本体などを関数パラメータとして一度宣言します。

これは、標準の最新の Python 型で行います。

新しい構文、特定のライブラリのメソッドやクラスなどを学ぶ必要はありません。

ちょうど標準的なPython 3.7+。

たとえば、次の場合です。

int

item_id: int

または、より複雑なモデルの場合:

Item

item: Item

...そして、その単一の宣言であなたは得ます:

• 以下を含むエディターのサポート:
  • 完了。
  • 型チェック。
• データの検証:
  • データが無効である場合の自動およびクリアエラー。
  • 深くネストされたJSONオブジェクトに対しても検証できます。
• 入力データの変換:ネットワークからPythonのデータと型への変換。から読む:
  • JSON.
  • パス パラメーター。
  • クエリ パラメーター。
  • クッキー。
  • ヘッダー。
  • フォーム。
  • ファイル。
• 出力データの変換:Pythonのデータと型からネットワークデータへの変換(JSONとして):
  • Pythonの型(,,,,,など)を変換します。

    str

    int

    float

    bool

    list

  • datetime

    オブジェクト。

  • UUID

    オブジェクト。
  • データベース モデル。
  • ...などなど。
• 2つの代替ユーザーインターフェイスを含む自動インタラクティブAPIドキュメント:
  • スワッガーUI。
  • リドク。

前のコード例に戻ると、FastAPIは次のようになります。

• 要求のパスに andid があることを検証します。

  item_id

  GET

  PUT

• タイプが要求であることを検証します。

  item_id

  int

  GET

  PUT

  • そうでない場合、クライアントには有用で明確なエラーが表示されます。
• forrequestsという名前のオプションのクエリパラメータがあるかどうかを確認します。

  q

  http://127.0.0.1:8000/items/foo?q=somequery

  GET

  • パラメータはで宣言されているため、オプションです。

    q

    = None

  • なしでそれは必要とされるでしょう(の場合の体もそうです)。

    None

    PUT

• 要求のために、本文をJSONとして読み取ります:

  PUT

  /items/{item_id}

  • 必須属性があることを確認してください。

    name

    str

  • 必須属性があることを確認してくださいそれはaでなければなりません。

    price

    float

  • オプションの属性 (存在する場合は a) があることを確認します。

    is_offer

    bool

  • All this would also work for deeply nested JSON objects.
• Convert from and to JSON automatically.
• Document everything with OpenAPI, that can be used by:
  • Interactive documentation systems.
  • Automatic client code generation systems, for many languages.
• Provide 2 interactive documentation web interfaces directly.

We just scratched the surface, but you already get the idea of how it all works.

Try changing the line with:

    return {"item_name": item.name, "item_id": item_id}

...from:

        ... "item_name": item.name ...

...to:

        ... "item_price": item.price ...

...and see how your editor will auto-complete the attributes and know their types:

For a more complete example including more features, see the Tutorial - User Guide.

Spoiler alert: the tutorial - user guide includes:

• Declaration of parameters from other different places as: headers, cookies, form fields and files.
• How to set validation constraints as or .

  maximum_length

  regex

• A very powerful and easy to use Dependency Injection system.
• Security and authentication, including support for OAuth2 with JWT tokens and HTTP Basic auth.
• More advanced (but equally easy) techniques for declaring deeply nested JSON models (thanks to Pydantic).
• GraphQL integration with Strawberry and other libraries.
• Many extra features (thanks to Starlette) as:
  • WebSockets
  • extremely easy tests based on and

    requests

    pytest

  • CORS
  • Cookie Sessions
  • ...and more.

Performance

Independent TechEmpower benchmarks show FastAPI applications running under Uvicorn as one of the fastest Python frameworks available, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)

詳細については、「ベンチマーク」セクションを参照してください。

オプションの依存関係

によって使用されます ピダンティック:

• ujson-JSONの「解析」を高速化します。
• email_validator-電子メールの検証用。

pip install "fastapi[all]"