チュートリアル - ユーザーガイド¶

このチュートリアルでは、FastAPIのほとんどの機能の使い方をステップバイステップで説明します。

各セクションは前のセクションに基づいて徐々に構築されていますが、トピックごとに分離されているため、特定のAPIのニーズを解決するために、どの特定のトピックにも直接移動できます。

また、将来の参考資料として機能するように構築されているため、必要なものを正確に戻って確認できます。

コードの実行¶

すべてのコードブロックは直接コピーして使用できます（実際にはテスト済みのPythonファイルです）。

いずれかの例を実行するには、コードをファイルmain.pyにコピーし、fastapi devを起動します。

$ <font color="#4E9A06">fastapi</font> dev <u style="text-decoration-style:solid">main.py</u>

  <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span>  Starting development server 🚀

             Searching for package file structure from directories
             with <font color="#3465A4">__init__.py</font> files
             Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font>

   <span style="background-color:#007166"><font color="#D3D7CF"> module </font></span>  🐍 main.py

     <span style="background-color:#007166"><font color="#D3D7CF"> code </font></span>  Importing the FastAPI app object from the module with
             the following code:

             <u style="text-decoration-style:solid">from </u><u style="text-decoration-style:solid"><b>main</b></u><u style="text-decoration-style:solid"> import </u><u style="text-decoration-style:solid"><b>app</b></u>

      <span style="background-color:#007166"><font color="#D3D7CF"> app </font></span>  Using import string: <font color="#3465A4">main:app</font>

   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  Server started at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font>
   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  Documentation at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000/docs</u></font>

      <span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span>  Running in development mode, for production use:
             <b>fastapi run</b>

             Logs:

     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Will watch for changes in these directories:
             <b>[</b><font color="#4E9A06">&apos;/home/user/code/awesomeapp&apos;</font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Uvicorn running on <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <b>(</b>Press CTRL+C
             to quit<b>)</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Started reloader process <b>[</b><font color="#34E2E2"><b>383138</b></font><b>]</b> using WatchFiles
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Started server process <b>[</b><font color="#34E2E2"><b>383153</b></font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Waiting for application startup.
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Application startup complete.

コードを書き写すかコピーし、編集してローカルで実行することを強くお勧めします。

エディタでそれを使用することで、FastAPIの利点が本当にわかります。いかに少ないコードを書けばよいか、すべての型チェック、オートコンプリートなど。

FastAPIのインストール¶

最初のステップはFastAPIをインストールすることです。

仮想環境を作成し、アクティブ化してからFastAPIをインストールしてください。

$ pip install "fastapi[standard]"

---> 100%

Note

pip install "fastapi[standard]"でインストールすると、FastAPI Cloudにデプロイできるfastapi-cloud-cliを含む、いくつかのデフォルトのオプションの標準依存関係が付属しています。

これらのオプションの依存関係を必要としない場合は、代わりにpip install fastapiをインストールできます。

標準の依存関係をインストールするが、fastapi-cloud-cliなしでインストールしたい場合は、pip install "fastapi[standard-no-fastapi-cloud-cli]"でインストールできます。

上級ユーザーガイド¶

このチュートリアル - ユーザーガイドの後に読むことができる上級ユーザーガイドもあります。

上級ユーザーガイドはこれに基づいて構築されており、同じ概念を使用し、いくつかの追加機能を教えてくれます。

しかし、まずチュートリアル - ユーザーガイド（今読んでいるもの）を読む必要があります。

チュートリアル - ユーザーガイドだけで完全なアプリケーションを構築し、その後、ニーズに応じて、上級ユーザーガイドからのいくつかの追加のアイデアを使用して、さまざまな方法でそれを拡張できるように設計されています。