Класс PlainTextResponse

Класс PlainTextResponse применяется для возврата ответа в виде обычного текста. Первым параметром передаётся содержимое ответа в виде строки. Вторым необязательным параметром можно передать код статуса, а третьим - заголовки ответа. Тип содержимого автоматически устанавливается в text/plain.

Синтаксис

from fastapi.responses import PlainTextResponse

PlainTextResponse(content, status_code=200, headers=None)

Пример

Давайте вернём простой текстовый ответ с адреса '/':

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()

@app.get('/')
def index():
	return PlainTextResponse('hello')

Результат выполнения кода:

"hello"

Пример

Давайте передадим код статуса 201 и заголовок X-Custom:

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()

@app.get('/user')
def user():
	return PlainTextResponse(
		'user created',
		status_code=201,
		headers={'X-Custom': 'abcde'}
	)

Результат выполнения кода:

"user created"

Пример

Давайте примем параметр name из URL и вернём его в виде текста:

from fastapi import FastAPI
from fastapi.responses import PlainTextResponse

app = FastAPI()

@app.get('/user/{name}')
def user(name: str):
	return PlainTextResponse(f'hello, {name}')

Результат выполнения кода для адреса /user/abcde:

"hello, abcde"

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

класс Response,
который является базовым классом для всех ответов
класс JSONResponse,
который возвращает ответ в формате JSON
класс HTMLResponse,
который возвращает ответ в формате HTML
атрибут media_type,
который задаёт тип содержимого ответа