Oracle Cloud Hangout Cafe Season6 #4「Pythonで作るAPIサーバー」(2022年12月7日開催)

仮想化／コンテナ

技術解説

連載 [第4回] :

「Oracle Cloud Hangout Cafe (OCHaCafe)」ダイジェスト2

2024年3月21日(木)

野中恭大郎

第2弾の連載第4回では、2022年12月7日に開催された「Oracle Cloud Hangout Cafe Season6 #4『Pythonで作るAPIサーバー』」の発表内容に基づいて紹介していきます。

Flask

Flaskは、Armin Ronacherによって開発されたオープンソースライセンス(BSDライセンス)のフレームワークです。テンプレートエンジンとしてJinja2、WSGIツールキットとしてWerkzeug(ヴェルクツォイク)を利用しています。

Jinja2: Pythonで利用できるHTMLテンプレートエンジン
Werkzeug: WSGIアプリケーションのためのユーティリティを集めたライブラリ

データベースの抽象化など、必要に応じて拡張(Extension)を行う軽量なフレームワークです。

・Flask - Getting Started
実際にFlaskを動かしてみましょう。以下のコマンドを実行して、Flaskをインストールします。

`1`	`$ python -m pip install Flask`

次のようにhello.pyファイルを作成します。

01from flask import Flask, Response
02 
03app = Flask(__name__)
04 
05@app.route('/hello')
06def hello():
07  return 'Hello, World'
08 
09@app.route('/hello/<name>')
10def name(name):
11  response = Response('Hello, '+ name)
12  response.mimetype = 'text/plain' 
13  return response</name>

Flaskのサーバを起動します。

1$ export FLASK_APP=hello.py #起動するアプリをFlaskに伝える
2$ export FLASK_ENV=development #サーバーを開発モードに設定
3$ flask run
4 * Serving Flask app 'hello' (lazy loading)
5 * Environment: production
6   WARNING: This is a development server. Do not use it in a production deployment.
7   Use a production WSGI server instead.
8 * Debug mode: off
9 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

http://127.0.0.1:5000/helloにアクセスします。

・Flaskプロジェクトのレイアウト
Flaskではディレクトリ構造などが特に定められているわけではありませんが、プロジェクト内に以下のようなディレクトリを持つことがプラクティスとされています。

flaskr/: アプリケーションのコードとファイルを含んだPythonパッケージ
tests/: テストモジュールを含んだディレクトリ
venv/: Flaskとその他の依存対象がインストールされたPythonの仮想環境
その他のファイル: インストールなどに利用

・Flaskアプリケーションのルーティング
Flaskでは、Route()デコレータを使用して関数とURLを関連付けできます。変数を扱いたい場合には< >を利用します。デコレータとは、関数やクラスにフレームワークの機能などを付加するための修飾子です。

・FlaskアプリケーションのHTTPメソッド
HTTPメソッドの記述も、Route()デコレータ内で行います。

1@app.route('/book/json', methods=['GET'])
2def book():
3  book = Book('example title', 'example author')
4  return jsonify(book.__dict__)

・Flaskで簡単なAPIを作成
実際にAPIを作成してみます。FlaskはDjangoよりもAPIに特化したフレームワークのため、簡単に実装できます。返却する値としてJSONを利用したいため、Extensionを追加してJSONレスポンスを取得するAPIを作成します。

hello.pyという名前のファイルを作成し、中身を以下のようにします。

01from flask import Flask, Response, jsonify
02 
03class Book:
04  def __init__(self, title, author):
05    self.title = title
06    self.author = author
07 
08app = Flask(__name__)
09 
10@app.route('/hello')
11def hello():
12  return 'Hello, World'
13 
14@app.route('/hello/<name>')
15def name(name):
16  response = Response('Hello, '+ name)
17  response.mimetype = 'text/plain' 
18  return response
19 
20@app.route('/book/json', methods=['GET'])
21def book():
22  book = Book('example title', 'example author')
23  return jsonify(book.__dict__)</name>

先述のflask runコマンドを利用し、サーバを起動します。

1$ export FLASK_APP=hello.py #起動するアプリをFlaskに伝える
2$ export FLASK_ENV=development #サーバーを開発モードに設定
3$ flask run

別のターミナルからcurlを実行します。

1$ curl -X GET http://127.0.0.1:5000/book/json
2{
3  "author": "example author", 
4  "title": "example title"
5}

FastAPI

FastAPIは@tiangolo(Sebastián Ramírez)によって開発された、Python 3.6以降でAPIを構築するためのオープンソース(MIT)・Webフレームワークです。REST APIの実装に特化しており、OpenAPIに準拠しています。自動でAPIドキュメントを生成する機能があり、Flaskのようにプラグインによる拡張も可能です。Starlette/Uvicorn/Pydanticをベースにしたフレームワークで、以下を担う構造です。

Starlette/Uvicorn: Web部分(ASGI Server)
Pydantic: データ部分(Validation/Serialization)

・FastAPI - Getting Started
実際にFastAPIを動かしてみましょう。以下のコマンドを実行して、FastAPIをインストールします。

`1`	`$ python -m pip install fastapi`

以下のようにhello.pyファイルを作成します。

1from fastapi import FastAPI
2 
3app = FastAPI()
4 
5@app.get('/')
6def read_root():
7  return {'hello':'world'}

アプリケーションの実行のためにASGIサーバ(ASGIについては先述)のインストールが必要です。Uvicornをインストールします。

`1`	`$ python -m pip install "uvicorn[standard]"`

Uvicornを起動します。

1$ uvicorn hello:app --reload
2INFO:     Will watch for changes in these directories: ['/home/opc/develop/python/fastapi']
3INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
4INFO:     Started reloader process [13722] using watchgod
5INFO:     Started server process [13724]
6INFO:     Waiting for application startup.
7INFO:     Application startup complete.

curlコマンドを実行します。

`1`	`$ curl -X GET http://127.0.0.1:8000`

`2`	`{"hello":"world"}`

・FastAPIアプリケーションのHTTPメソッド
FastAPIのHTTPメソッド指定はFlaskとは若干異なり、それぞれのデコレータが用意されています。

1class Item(BaseModel):
2  id: int
3 
4@app.post('/items/')
5async def post_item(item: Item):
6  return item

・FastAPIアプリケーションのルーティング
関数とパスを関連付ける形でアプリケーションのルーティングを行います。

1@app.get('/')
2def read_root():
3  return {'hello':'world'}

パスパラメータを利用できます。

1@app.get('/items/{item_id}')
2def get_item(item_id: int, q: str = None):
3  return {'item_id': item_id, 'q': q}

クエリパラメータを(`?item_id=1000`のように)渡すことも可能です。

1@app.get('/items/')
2async def get_item(item_id: int = 0):
3  return {'item_id': item_id}

・FastAPIの自動ドキュメント生成
[endpoint]/docsにアクセスすると、自動生成された Swagger UIにアクセスできます。

・FastAPIで簡単なAPIを作成
ここまでのサンプルコードをhello.pyに記述します。

01from fastapi import FastAPI
02 
03app = FastAPI()
04 
05@app.get('/')
06def read_root():
07  return {'hello':'world'}
08 
09@app.get('/items/{item_id}')
10def get_item(item_id: int, q: str = None):
11  return {'item_id': item_id, 'q': q}
12 
13@app.get('/items/')
14async def get_item(item_id: int = 0):
15  return {'item_id': item_id}
16 
17from pydantic import BaseModel
18 
19class Item(BaseModel):
20  id: int
21 
22@app.post('/items/')
23async def post_item(item: Item):
24  return item

ASGIサーバを起動します。

`1`	`$ uvicorn hello:app`

別のターミナルからAPIを実行してみます。

01$ curl -X GET http://127.0.0.1:8000/items/1
02{"item_id":1,"q":null}
03 
04$ curl -X GET http://127.0.0.1:8000/items/?item_id=1000
05{"item_id":1000}
06 
07$ curl -X 'POST' \
08>   'http://127.0.0.1:8000/items/' \
09>   -H 'accept: application/json' \
10>   -H 'Content-Type: application/json' \
11>   -d '{
12>   "id": 0
13> }'
14{"id":0}