質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.35%
Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Webサーバー

Webサーバーとは、HTTPリクエストに応じて、クライアントに情報を提供するシステムです。

Q&A

1回答

5821閲覧

FastAPI()とAPIRouter()の使い分け

atabo

総合スコア9

Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Webサーバー

Webサーバーとは、HTTPリクエストに応じて、クライアントに情報を提供するシステムです。

0グッド

0クリップ

投稿2021/12/17 07:35

FastAPIを勉強中なのですが、次の二つの使い分けの仕方を教えて欲しいです。

app = FastAPI() # ① router = APIRouter() # ②

①については公式ドキュメントに次のようにあります。

from fastapi import FastAPI app = FastAPI() @app.get("/") async def root(): return {"message": "Hello World"}

②についても公式ドキュメントに次のようにあります。

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}

"/users/{username}"のように、マイページなどのユーザー名毎にURLを変えたい場合などに
APIRouter()を使うのかなぁ、という印象を受けたのですが、
ある書籍では次にように使われています。

router = APIRouter() @router.get("/health") def health() -> Dict[str, str]: return {"health": "ok"}

これは app = FastAPI()ではできないのでしょうか?
基本的にAPIRouter()の方をメインで使ってしまって問題ないということでしょうか?

Webアプリ開発の基本的なところから理解できていないための質問になっている可能性もありますが
教えて頂けると大変ありがたいです。

よろしくお願いします。

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

FastAPIについては詳しくありませんが、殆どFlaskと同じなので回答します。

以下を見ると、FlaskとFastAPIの使い方がまとめられています。
https://zenn.dev/satto_sann/articles/b405ca8961d70fac99ff

FastAPIのAPIRouterはFlaskのBlueprintに該当するもののようです。
Blueprintは、エンドポイントを複数作る場合にファイル分割するのに使用します。

そのため、APIRouterも同様の使用方法をするものと推察します。
そのため回答としては、

これは app = FastAPI()ではできないのでしょうか?

FastAPI()とすることは可能です。

になります。

基本的にAPIRouter()の方をメインで使ってしまって問題ないということでしょうか?

こちらについては、「いいえ」です。
「メインで」というのがおかしく、メインはFastAPI()です。
別途APIRouter()で宣言したものをapp.include_router(user.router)の様に、appに追加する形で使用します。

投稿2022/03/09 06:42

FiroProchainezo

総合スコア2424

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

まだベストアンサーが選ばれていません

会員登録して回答してみよう

アカウントをお持ちの方は

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.35%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問