Параметр path

Параметр path применяется к классу FileResponse и указывает путь к файлу на диске, содержимое которого нужно отдать клиенту. Первым позиционным параметром передаётся путь к файлу. Путь может быть абсолютным или относительным. FastAPI читает файл и отправляет его в теле ответа.

Синтаксис

FileResponse(path)

Пример

Давайте отдадим файл 'article.txt' по адресу '/file':

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/file')
def get_file():
	return FileResponse(path='article.txt')

Результат выполнения кода для файла с содержимым 'hello':

"hello"

Пример

Давайте укажем абсолютный путь к файлу и зададим имя файла для клиента:

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/download')
def download():
	return FileResponse(
		path='/var/www/files/article.txt',
		filename='article.txt'
	)

Клиент получит файл с именем 'article.txt' и содержимым из указанного пути.

Пример

Давайте отдадим файл с явным указанием медиатипа:

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get('/text')
def get_text():
	return FileResponse(
		path='article.txt',
		media_type='text/plain'
	)

Результат выполнения кода для файла с содержимым 'abcde':

"abcde"

Смотрите также

класс FileResponse,
который отдаёт файл в ответе
параметр filename,
который задаёт имя файла для клиента
параметр media_type,
который задаёт MIME-тип файла
параметр stat_result,
который задаёт статистику файла