Параметр deprecated

Параметр deprecated применяется к методам приложения FastAPI, регистрирующим маршруты. Он принимает булево значение и помечает эндпоинт как устаревший. В интерактивной документации такой маршрут отображается перечёркнутым, а клиентам рекомендуется использовать другой URL. По умолчанию параметр равен False.

Синтаксис

@app.get(path, deprecated=True)

Пример

Давайте поместим старый маршрут как устаревший:

from fastapi import FastAPI

app = FastAPI()

@app.get('/old', deprecated=True)
def old_route():
	return {'text': 'hello'}

@app.get('/new')
def new_route():
	return {'text': 'hello'}

В документации /docs маршрут /old будет перечёркнут и помечен как deprecated, при этом запрос к нему продолжит работать:

{"text": "hello"}

Пример

Давайте зададим параметр через переменную:

from fastapi import FastAPI

app = FastAPI()

is_deprecated = True

@app.get('/article', deprecated=is_deprecated)
def article():
	return {'text': 'article'}

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

{"text": "article"}

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

метод get,
который вешает обработчик на GET-запрос
метод post,
который вешает обработчик на POST-запрос
метод api_route,
который вешает обработчик на произвольный HTTP-метод
параметр include_in_schema,
который скрывает маршрут из документации