スポンサーリンク

【入門/使い方】PythonのFastAPIでREST API(GET)を作る手順

【入門/使い方】PythonのFastAPIでRestAPI(GET)を作る手順

 

★悩み★
・PythonのFast APIを使えば、REST APIのGETメソッドは作れるのかな?
・PythonのFast APIをインストールする手順を知りたいな。
・PythonのFast APIの使い方(特にREST APIのGETメソッド)を知りたいな。


こういった「悩み」に答えます。
 

★本記事の内容★
① PythonのFastAPIでREST API(GET)を作るための準備をご紹介
④ PythonのFastAPIでREST API(GET)を作成する手順と使い方をご紹介


これからご紹介する「PythonのFastAPIでREST API(GET)を作る手順」を実践したことで、30分以内で「PythonのFastAPIでREST APIのGETメソッドを作成」できました。

記事の前半では「PythonやFast APIをインストールする手順」を解説しつつ、記事の後半では「PythonのFastAPIでREST API(GETメソッド)を作成する手順と使い方」を紹介します。

この記事を読み終えることで、「PythonのFast APIでREST API(GETメソッド)を作れる」状態になります。
 

PythonのFastAPIでREST API(GET)を作るための準備

PythonのFastAPIでREST API(GET)を作るための準備


「PythonのFastAPIでREST API(GET)を作るための準備」に関してご紹介します。

★PythonのFastAPIでREST API(GET)を作るための準備の流れ★
手順1:Pythonをインストール
手順2:Pythonライブラリ(FastAPI)をインストール


上記の流れで、「PythonのFastAPIでREST API(GET)を作るための準備」ができます。
 

上記の各手順は、以下の日時と環境で動作確認済みです。
動作確認済み日時:2021年6月10日
動作確認済み環境:CentOS Linux release 7.7.1908 (Core)


以降で、上記「PythonのFastAPIでREST API(GET)を作るための準備の流れ」の各手順に関してご説明します。
 

手順1:Pythonをインストール【FastAPIを使うために必要】

「手順1:Pythonをインストール」に関してご説明します。
 

FastAPIは、Pythonのライブラリです。そのため、FastAPIを使いたい場合、Pythonをインストールする必要があります。


「Pythonのインストール手順」に関しては、以下の記事をご覧ください。
 

 

既にPythonをインストールされている方は、本手順を省略してください。


以上で、「手順1:Pythonのインストール」は完了です。
 

手順2:Pythonライブラリ(FastAPI)をインストール

「手順2:Pythonライブラリ(FastAPI)をインストール」に関してご説明します。
 

Pythonを使ってREST APIを作成するために、Pythonライブラリ「FastAPI」をインストールしましょう。


「端末」または「コマンドプロンプト」を起動し、以下のコマンドを実行してください。

# pip install fastapi uvicorn
# pip list | grep fastapi
fastapi                         0.65.1
# pip list | grep uvicorn
uvicorn                         0.13.4
# 


上記のように「fastapi (バージョン名)」と「uvicorn(バージョン名)」が表示された場合、「正常にFastAPIをインストールできた」と判断できます。


以上で、「手順2:Pythonライブラリ(FastAPI)をインストール」は完了です。
 

上記の流れで、「PythonのFastAPIでREST API(GET)を作るための準備」ができました。

 

PythonのFastAPIでREST API(GET)を作成する手順と使い方

PythonのFastAPIでREST API(GET)を作成する手順と使い方


「PythonのFastAPIでREST API(GET)を作成する手順と使い方」に関してご紹介します。

★PythonのFastAPIでREST API(GET)を作成する流れ★
手順1:PythonのFastAPIでREST API(GET)を実現するプログラムを作成
手順2:「FastAPIでREST API(GET)を実現するプログラム」の動作確認


上記の流れで、「PythonのFastAPIでREST API(GET)を作成」できます。
 

上記の各手順は、以下の日時と環境で動作確認済みです。
動作確認済み日時:2021年6月10日
動作確認済み環境:CentOS Linux release 7.7.1908 (Core)


以降で、上記「PythonのFastAPIでREST API(GET)を作成する流れ」の各手順に関してご説明します。
 

手順1:PythonのFastAPIでREST API(GET)を実現するプログラムを作成

「手順1:PythonのFastAPIでREST API(GET)を実現するプログラムを作成」に関してご説明します。
 

PythonのFastAPIでREST API(GET)を実現するプログラムを作成しましょう。


「PythonのFastAPIでREST API(GET)を実現する」プログラムは、以下となります。

# Pythonライブラリ(FastAPI)をインポート
from fastapi import FastAPI

# FastAPIのオブジェクトを作成
app = FastAPI()

# /に対するGETの処理
@app.get('/')
async def hello():
    return {"text": "hello world!"}


上記のプログラムを「python-fastapi-get.py」というファイル名で保存しましょう。

以上で、「手順1:PythonのFastAPIでREST API(GET)を実現するプログラムを作成」は完了です。
 

手順2:「FastAPIでREST API(GET)を実現するプログラム」の動作確認

「手順2:「FastAPIでREST API(GET)を実現するプログラム」の動作確認」に関してご説明します。
 

作成した「PythonFastAPIでREST API(GET)を実現するプログラム」を実行しましょう。


以下のコマンドを実行し、手順1で作成した「PythonのFastAPIでREST API(GET)を実現するプログラム」の動作を確認しましょう。

# uvicorn main:app --reload
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [3605] using statreload
INFO:     Started server process [3639]
INFO:     Waiting for application startup.
INFO:     Application startup complete.


上記のように「Application startup complete.」と表示された場合、「FastAPIでREST API(GET)を実現するプログラム」を正常に起動できたと判断できます。

次に、以下のコマンドを実行し、REST API(GETメソッド)の動作を確認してください。

# curl http://127.0.0.1:8000/
{"text":"hello world!"}


上記のように「{“text”:”hello world!”}」と表示された場合、「FastAPIでREST API(GET)を実現するプログラム」を正常に動作したと判断できます。

以上で、「手順2:「FastAPIでREST API(GET)を実現するプログラム」の動作確認」は完了です。
 

上記の手順で、PythonのFastAPIでREST API(GET)を作成できました。


ちなみに、「PythonのFastAPIをもっと詳しく知りたい」方には、公式サイトを閲覧することをオススメします。(udemyや書籍において、FastAPIを解説しているものはありませんでした)
FastAPIの公式サイト

 

【まとめ】PythonのFastAPIでREST API(GET)を作る手順

【入門/使い方】PythonのFastAPIでREST API(GET)を作る手順


今回の記事を通して、「PythonのFastAPIでREST API(GET)を作る手順」をご紹介することで、以下の悩みを解消しました。
 

★悩み★
・PythonのFast APIを使えば、REST APIのGETメソッドは作れるのかな?
・PythonのFast APIをインストールする手順を知りたいな。
・PythonのFast APIの使い方(特にREST APIのGETメソッド)を知りたいな。


PythonのFastAPIでREST API(GET)を作る手順?」で悩んでいるあなたにこの記事が少しでも役に立てれば幸いです。

コメント

タイトルとURLをコピーしました