Параметр servers

Параметр servers передаётся в конструктор класса FastAPI и задаёт список серверов, которые будут отображаться в документации OpenAPI. Каждый сервер описывается словарём с ключами url и необязательным description. Этот параметр полезен, когда приложение доступно по нескольким адресам, например, на разных стендах.

По умолчанию параметр равен None, и FastAPI автоматически подставляет корневой путь / в качестве единственного сервера.

Синтаксис

app = FastAPI(servers=[{'url': '...', 'description': '...'}])

Пример

Давайте создадим приложение с двумя серверами:

from fastapi import FastAPI

app = FastAPI(
	servers=[
		{'url': 'https://api.example.com', 'description': 'Production server'},
		{'url': 'https://staging.example.com', 'description': 'Staging server'}
	]
)

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

Теперь в документации по адресу /docs в выпадающем списке серверов можно будет выбрать любой из указанных адресов.

Пример

Давайте укажем относительный путь сервера:

<+python+> from fastapi import FastAPI app = FastAPI( servers=[ {'url': '/v1', 'description': 'Version 1 API'}, {'url': '/v2', 'description': 'Version 2 API'} ] ) @app.get('/users') def get_users(): return {'users': ['abcde', 'article']} <-python+>

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

{"users": ["abcde", "article"]}

При этом в OpenAPI-схеме появится список серверов с относительными путями /v1 и /v2.

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

класс FastAPI,
который создаёт приложение FastAPI
параметр root_path,
который задаёт корневой путь приложения
параметр title,
который задаёт название приложения
атрибут openapi_schema,
который хранит схему OpenAPI