【Python】FastAPIでファイルをダウンロードするWeb APIをつくる

こんにちは。現役エンジニアの”はやぶさ”@Cpp_Learningです。

PythonのWebフレームワーク FastAPI を活用した簡単な Web APIの作り方をソースコード付きで紹介します。

Contents

1 今回つくるWeb API -ファイルダウンローダ-
2 環境構築
3 実践 FastAPIでWeb API開発
- 3.1 FastAPI製のファイルダウンローダ Web API
- 3.2 自作Web API起動
4 VSCodeの拡張機能：REST ClientによるWeb APIの動作確認
5 まとめ

今回つくるWeb API -ファイルダウンローダ-

今回つくるWeb APIはサーバー側にある任意のファイルをクライアント側に保存するファイルダウンローダです。

環境構築

既にPython開発環境がある場合は、以下のコマンドで各種インストールすればOKです。

pip install fastapi
pip install uvicorn[standard]

Dockerを使う場合は、FastAPI公式イメージを活用するのがオススメです。Dockerによるプログラミング開発環境構築については、以下の記事を参考にして下さい。

WSL2とDockerとVSCodeのRemote Containersで最高の開発環境をつくるこんにちは。現役エンジニアの”はやぶさ”@Cpp_Learningです。 WSL2 + Docker + VS Code の Re...

実践 FastAPIでWeb API開発

プロジェクトフォルダの構成は以下の通りです。

 
workspace
     └─fastapi-example
            │──files
            │   │──download_file.png
            │   │──download_file.csv
            │   └──download_file.txt
            └──app.py

workspace

└─fastapi-example

│──files

│ │──download_file.png

│ │──download_file.csv

│ └──download_file.txt

└──app.py

filesフォルダの中身がダウンロードされるファイルです。

FastAPI製のファイルダウンローダ Web API

FastAPIのサンプルコードを参考に作った app.py のソースコードが以下です。

from pathlib import Path
from datetime import datetime

import uvicorn
from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/")
def home():
    return {"message": "Sample App"}


@app.get("/get_file/{filename:path}")
async def get_file(filename: str):
    '''任意ファイルのダウンロード'''
    current = Path()
    file_path = current / "files" / filename
    
    now = datetime.now()
    
    response = FileResponse(
                            path=file_path,
                            filename=f"download_{now.strftime('%Y%m%d%H%M%S')}_{filename}"
                            )

    return response


if __name__ == "__main__":
    uvicorn.run("app:app", host="127.0.0.1", port=8000, reload=True)

from pathlib import Path

from datetime import datetime

import uvicorn

from fastapi import FastAPI

from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/")

def home():

return {"message": "Sample App"}

@app.get("/get_file/{filename:path}")

async def get_file(filename: str):

'''任意ファイルのダウンロード'''

current = Path()

file_path = current / "files" / filename

now = datetime.now()

response = FileResponse(

path=file_path,

filename=f"download_{now.strftime('%Y%m%d%H%M%S')}_{filename}"

)

return response

if __name__ == "__main__":

uvicorn.run("app:app", host="127.0.0.1", port=8000, reload=True)

FastAPIを活用することで、非常に短いスッキリしたソースコードに仕上がりました。

最初は StreamingResponse を使っていましたが、FileResponse という非常に便利な機能があったので切り替えました。ファイル名を含むパスパラメータからメディアタイプを自動推定するのが最高でした。

自作Web API起動

以下のコマンドで app.py を実行すれば、自作のWeb APIサーバーが起動します。

python app.py

ブラウザなどから http://127.0.0.1:8000/get_file/{filename} というリクエストを投げると、ファイルをダウンロードできます。

あるいは http://127.0.0.1:8000/docs にアクセスすれば、”Try it out”ボタンで動作確認できます（詳しくは公式ドキュメントをご覧ください）。

サーバー側の filesフォルダ に保存していないファイル名を指定してクエストを投げた場合は、以下のレスポンスが返ってきます。

VSCodeの拡張機能：REST ClientによるWeb APIの動作確認

個人的にはVSCodeの拡張機能：REST Client を使って動作確認するのが好きなので、最後に今回つくった test.http と動作確認したときの様子を紹介します。

くるる

REST Client ってなに？美味しいの？

という人やフクロウは以下の記事を参考にしてください。

Webアプリ開発に役立つVSCodeの拡張機能３選Webアプリ開発に役立つVisual Studio Codeの拡張機能を紹介した記事です。...

test.http

今回つくったtest.httpは以下の通りです。

###################
#
# FastAPIでつくるファイルダウンロード
#
###################
GET http://127.0.0.1:8000/

###
GET http://127.0.0.1:8000/get_file/iris.csv

###
GET http://127.0.0.1:8000/get_file/kururu.png

###
GET http://localhost:8000/get_file/hoge.txt