FastAPI経由でサーバ上のファイルをダウンロードする方法

概要

本記事では FastAPI を利用してサーバー上のファイルを API 経由でダウンロードするための方法について解説します。

実装

ファイルを API 経由でダウンロードさせるためにはFileResponseを利用します。具体的には、FileResponseでpathにダウンロードさせたいファイルへのパスを指定したものを API の返り値とします。以下のコードは実装例となります。この例ではパスパラメータとして任意のfile_pathを受け付けるようにしています。

import os
from fastapi import FastAPI, HTTPException
from fastapi.responses import FileResponse

app = FastAPI
@router.get("/download_file/{file_path:path}", status_code=200)
def download_model(display_name: str, file_path: str) -> List:
		if not os.path.exists(file_path):
			retrun HTTPException(status_code=404, detail="File not found")
    response = FileResponse(
        path=file_path,
        filename=file_path,
    )
    return

参照

FileResponse - FastAPI Docs

備考

Hakky ではエンジニアを募集中です！まずは話してみたいなどでも構いませんので、ぜひお気軽に採用ページからお問い合わせくださいませ。