Атрибут openapi_url

Атрибут openapi_url применяется к приложению FastAPI и задаёт URL-адрес, по которому доступна OpenAPI-схема. Значение атрибута устанавливается при создании приложения через одноимённый параметр конструктора. По умолчанию атрибут равен '/openapi.json'. Если передать None, схема не будет генерироваться, а автоматическая документация станет недоступной.

Синтаксис

app.openapi_url

Пример

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

from fastapi import FastAPI

app = FastAPI()

print(app.openapi_url)

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

"/openapi.json"

Пример

Давайте изменим адрес OpenAPI-схемы через параметр openapi_url при создании приложения:

from fastapi import FastAPI

app = FastAPI(openapi_url='/api/schema.json')

print(app.openapi_url)

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

"/api/schema.json"

Теперь схема доступна по адресу '/api/schema.json'.

Пример

Давайте отключим генерацию OpenAPI-схемы, передав None:

from fastapi import FastAPI

app = FastAPI(openapi_url=None)

print(app.openapi_url)

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

None

В этом случае эндпоинт '/openapi.json' не создаётся, а страницы '/docs' и '/redoc' перестают работать.

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

класс FastAPI,
который создаёт приложение и хранит атрибут openapi_url
атрибут openapi_schema,
который хранит сгенерированную OpenAPI-схему приложения
атрибут docs_url,
который задаёт адрес страницы Swagger UI
атрибут redoc_url,
который задаёт адрес страницы ReDoc