Атрибут docs_url
Атрибут docs_url хранится у экземпляра класса
FastAPI и содержит строку с адресом страницы
Swagger UI. По умолчанию он равен '/docs'.
Атрибут можно задать при создании приложения через
одноимённый параметр конструктора либо изменить
уже после создания. Если передать None,
страница документации отключается.
Синтаксис
app = FastAPI(docs_url='/docs')
Пример
Давайте посмотрим значение атрибута по умолчанию:
from fastapi import FastAPI
app = FastAPI()
@app.get('/')
def index():
return {'text': 'hello'}
print(app.docs_url)
Результат выполнения кода:
"/docs"
Пример
Давайте зададим свой адрес для документации:
from fastapi import FastAPI
app = FastAPI(docs_url='/article')
@app.get('/')
def index():
return {'text': 'hello'}
print(app.docs_url)
Результат выполнения кода:
"/article"
Теперь Swagger UI доступен по адресу /article,
а не по /docs.
Пример
Давайте отключим страницу документации, передав None:
from fastapi import FastAPI
app = FastAPI(docs_url=None)
@app.get('/')
def index():
return {'text': 'hello'}
print(app.docs_url)
Результат выполнения кода:
None
Смотрите также
-
атрибут
redoc_url,
который задаёт путь к документации ReDoc -
атрибут
openapi_url,
который задаёт путь к OpenAPI-схеме -
атрибут
title,
который задаёт заголовок приложения -
класс
FastAPI,
который создаёт приложение FastAPI
