FastAPI モジュール - 基本

[FastAPI モジュール - 基本 - Qiita](https://qiita.com/sand/items/ebd4812138e0a5d3a444)
[FastAPI モジュール - APIRouter - Qiita](https://qiita.com/sand/items/081fd06ce93ddcaa6725)


FastAPIで現実的に大規模なアプリを構築するのにはどうすればよいでしょう。ここではFastAPIを複数のファイル（モジュール）に分けて書き、それらを統合して一つのFastAPIアプリを構築する方法を記します。公式サイトには、サンプルプログラムが丁寧に説明してありますが、チュートリアルにしては少し複雑な気がするので、バラシテ少しづつ見ていきたいと思います。

[Bigger Applications - Multiple Files - 公式サイト](https://fastapi.tiangolo.com/tutorial/bigger-applications/#the-main-fastapi)


最後に**Global Dependencies**の簡単な紹介と、それが各サブモジュールに対しても有効に働いていることを確認します。

# １．基本
## １－１．ディレクトリ構成

今回はmain.pyとusers.pyの2つのファイルから成るアプリを考えます。Pythonのモジュールとパッケージの定義を思い出しながら、以下のディレクトリ構成を考えてください。


```
.
├── app                  # "app" はPython パッケージ
│   ├── __init__.py      # "app" を "Python パッケージ"にする
│   ├── main.py          # "main" モジュール, e.g. import app.main
│   └── routers          # "routers" は"Python サブパッケージ"
│   │   ├── __init__.py  # "routers" を"Python サブパッケージ"にする
│   │   └── users.py     # "users" サブモジュール, e.g. import app.routers.users
```

Pythonのモジュールとパッケージなので、Pythonだけの観点から言えば import 文によって複数のファイルは結合できます。しかしFastAPIの**path operations**は、それぞれのモジュールでどのように定義し、最終的に一つに統合すればよいのでしょうか？　以下に見ていきたいと思います。


## １－２．users.py

まずはサブモジュール users.pyから見ていきます。**サブモジュールにおいてpath operationsの定義は、FastAPI()の代わりに、APIRouter()を使います。**

```python:app/routers/users.py
from fastapi import APIRouter

router = APIRouter()

@router.get("/users/", tags=["users"])
async def read_users():
    return [{"username": "Rick"}, {"username": "Morty"}]

@router.get("/users/me", tags=["users"])
async def read_user_me():
    return {"username": "fakecurrentuser"}

@router.get("/users/{username}", tags=["users"])
async def read_user(username: str):
    return {"username": username}
```


APIRouterクラスの使い方は、FastAPIクラスとほぼ同じで、ミニFastAPIクラスと考えることができます。FastAPIクラスの全てのオプションが同じように使えます。例えばparameters, responses, dependencies, tagsなどです。

ここでは全てのPath operationsに tags=["users"]を指定しているので、SwaggerUI上ではこの3つのパスはusersタグに分けられて表示されます。


## １－３．main.py

```python:app/main.py
from fastapi import FastAPI
from .routers import users

app = FastAPI()

app.include_router(users.router)

@app.get("/")
async def root():
    return {"message": "Hello Bigger Applications!"}
```

**app.include_router()によって、FastAPIのpath operationsのレベルで、users モジュールはmainモジュールに結合されています。**
app.include_router(users.router)　はサブモジュールusersのrouterをインクルードしています。users.router はapp/routers/users.py ファイルで定義されているAPIRouterを含んでいます。APIRouterの変数名が routerであることに注意してください。これによって、usersのAPIRouterがmainに追加されます。


## １－４．SwaggerUI

起動してみます。

```
uvicorn app.main:app --reload
```

### （１）初期画面

３つのgetメソッドが**「users」タグ**の元表示されています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/61915/87ab6244-a479-930a-3c7e-8b146e8c913b.png)


### （２）/users/パス

一番先頭の**/users/パス**にアクセスしてみます。うまく動作しているのがわかります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/61915/215b0f10-aa13-f759-a498-c7ca61423fa3.png)

### （３）通常のブラウザでアクセス

念のために、以下のURLに、SwaggerUIからではなく、普通のブラウザでアクセスする。

```
http://localhost:8000/users/
```

正常にレスポンスがあります。

```
[{"username":"Rick"},{"username":"Morty"}]
```



# ２．Global Dependencies

## ２－１．Global Dependenciesとは
Global Dependenciesによって、アプリ全体にdependencies を適用することができます。これは***path operation decorators**を全デコレータに適用したと同じ意味を持ちます。

[Dependencies in path operation decorators - 公式サイト](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/)
[Global Dependencies - 公式サイト](https://fastapi.tiangolo.com/tutorial/dependencies/global-dependencies/)
[FastAPI OAuth2パスワード認証 - Qiita](https://qiita.com/sand/items/95a3502066efe508e36f)

## ２－２．ディレクトリ構成

これまでのディレクトリ構成に、dependencies.pyを追加します。dependencies.pyは単なるPythonのモジュールですが、FastAPIのGlobal Dependenciesに用いられます。



```
.
├── app                  # "app" はPython パッケージ
│   ├── __init__.py      # "app" を "Python パッケージ"にする
│   ├── main.py          # "main" モジュール, e.g. import app.main
│   ├── dependencies.py  # "dependencies" モジュール, e.g. import app.dependencies
│   └── routers          # "routers" は"Python サブパッケージ"
│   │   ├── __init__.py  # "routers" を"Python サブパッケージ"にする
│   │   └── users.py     # "users" サブモジュール, e.g. import app.routers.users
```



## ２－３．main.py
例えば、mainのFastAPIクラスを以下のように変更します。

```python::app/main.py
from fastapi import Depends, FastAPI
from .dependencies import get_query_token
from .routers import users

app = FastAPI(dependencies=[Depends(get_query_token)])

app.include_router(users.router)

@app.get("/")
async def root():
    return {"message": "Hello Bigger Applications!"}
```

## ２－４．dependencies.py
dependencies.pyを以下のように定義します。クエリパラメータで渡されたtokenを取り出す関数です。

```python:app/dependencies.py
from fastapi import Header, HTTPException

async def get_query_token(token: str):
    if token != "jessica":
        raise HTTPException(status_code=400, detail="No Jessica token provided")
```

## ２－５．SwaggerUI

以上で、Global Dependenciesの設定が終わったのでアプリを起動します。

```
uvicorn app.main:app --reload
```

全てのgetのリクエストにtokenの入力が要求されます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/61915/77abf988-0f1f-60a0-f5b6-e07a3030dd45.png)

### （１）token 正常値

token=**jessica**と入力して実行します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/61915/908c6f0a-2e8e-77e6-d6be-867a25bc7228.png)

成功しました。

### （２）tokenエラー値
今度はtokenに適当な値を入れてみます。token=**abcdefg**と入力して実行します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/61915/973b2504-44fa-ab3a-a57a-968cbadb1898.png)

期待したエラーが出ました。


### （３）token無し

念のために、以下のURLに、SwaggerUIからではなく、普通のブラウザでアクセスする。

```
http://localhost:8000/users/
```

期待通りにtokenの値が無い旨のエラーとなります。

```
{"detail":[{"loc":["query","token"],"msg":"field required","type":"value_error.missing"}]}
```

///


今回は以上です。