Логическое значение, указывающее, следует ли возвращать отладочные трассировки при ошибках сервера.

Посмотреть документацию Starlette для приложений.

Тип: bool: False

Обычно вы не используете этот параметр с FastAPI, он унаследован от Starlette и поддерживается для совместимости. Этот параметр принимает список маршрутов для обслуживания входящих запросов HTTP и WebSocket.

Тип: Optional[List[BaseRoute]]По умолчанию: None

Название вашего API. Оно будет добавлено в OpenAPI (например, в документации /docs).

Пример:

from fastapi import FastAPI

app = FastAPI(title="My_First_Project")

Тип: str: 'FastAPI'

Краткое описание API. Оно будет добавлено в OpenAPI (например, в документации /docs).

Пример

from fastapi import FastAPI

app = FastAPI(summary="My CRUD application.")

Тип: Optional[str]По умолчанию: None

Описание API. Поддерживает Markdown (с использованием синтаксиса CommonMark). Оно будет добавлено в OpenAPI (например, в документации /docs).

Пример 

from fastapi import FastAPI
app = FastAPI( description="""The CRUD application supports writing,
                              reading, updating and deleting posts.""")

Тип: str: ''

Версия API. Она будет добавлена в OpenAPI (например, в документации /docs).

Обратите внимание, что это версия вашего приложения, а не версия спецификации OpenAPI и не используемая версия FastAPI.

Пример

from fastapi import FastAPI

app = FastAPI(version="0.0.1")

Тип: str: '0.1.0'

URL-адрес, на котором будет доступна схема OpenAPI.

Пример

from fastapi import FastAPI

app = FastAPI(openapi_url="/api/v1/openapi.json")

Тип: Optional[str]  По умолчанию: '/openapi.json'

Список тегов, используемых OpenAPI, это те же теги, которые вы можете установить в операциях пути, например:

• @app.get("/users/", tags=["users"])
• @app.get("/items/", tags=["items"])

Теги можно использовать для указания порядка, показанного в таких документациях, как пользовательский интерфейс Swagger, используемых в /docs.

Узнайте больше в документации FastAPI для URL-адресов метаданных.

Тип: Optional[List[Dict[str, Any]]] По умолчанию: None

Список словарей с информацией о подключении к целевому серверу.

Вы можете использовать это, например, если ваше приложение обслуживается из разных доменов, и вы хотите использовать один и тот же пользовательский интерфейс Swagger для взаимодействия с каждым из них (вместо того, чтобы открывать несколько вкладок браузера).

Узнайте больше в документации FastAPI.

Пример

app = FastAPI(servers=[{"url": "https://stag.example.com", "description": "Staging"},
                       {"url": "https://prod.example.com", "description": "Production"}, ])

Тип: Optional[List[Dict[str, Union[str, Any]]]]По умолчанию: None

Используемый класс ответа. Узнайте больше в документации FastAPI для пользовательского ответа - HTML, Stream, File и другие.

Пример 

from fastapi import FastAPI
from fastapi.responses import ORJSONResponse

app = FastAPI(default_response_class=ORJSONResponse)

Тип: Type[Response] По умолчанию: Default(JSONResponse)

Следует ли обнаруживать и перенаправлять косые черты в URL-адресах, когда клиент не использует тот же формат.

Пример  

from fastapi import FastAPI
app = FastAPI(redirect_slashes=True)  # the default


@app.get("/items/")
async def read_items():
    return {"item_id": "Foo"}

С помощью этого параметра, если клиент переходит в /items (без завершения косой черты), он будет автоматически перенаправлен с кодом состояния HTTP 307 на /items/.

Тип: bool: True

Путь к автоматической интерактивной документации API. URL-адрес по умолчанию - /docs. Вы можете отключить его, установив в None. Мы это рассматривали в разделе 1.4 данного курса.

Тип: Optional[str] По умолчанию: '/docs'

Путь к альтернативной автоматической интерактивной документации API, предоставленной ReDoc.

URL-адрес по умолчанию - /redoc. Вы можете отключить его, установив в None. Мы это рассматривали в разделе 1.4 данного курса.

Тип: Optional[str] По умолчанию: '/redoc'

Конечная точка перенаправления OAuth2 для пользовательского интерфейса Swagger.

По умолчанию это /docs/oauth2-redirect.

Это используется только в том случае, если вы используете OAuth2 (с кнопкой "Авторизовать") с пользовательским интерфейсом Swagger.

Тип: Optional[str] По умолчанию: '/docs/oauth2-redirect'

Конфигурация OAuth2 для пользовательского интерфейса Swagger, по умолчанию отображается в /docs.

Тип: Optional[Dict[str, Any]]  По умолчанию: None

Список промежуточного программного обеспечения, которое будет добавлено при создании приложения.

В FastAPI вы обычно делаете это с помощью app.add_middleware().

Тип: Optional[Sequence[Middleware]] По умолчанию: None

Словарь с обработчиками исключений. В FastAPI вы обычно используете декоратор @app.exception_handler().

Тип:Optional[Dict[Union[int, Type[Exception]], Callable[[Request, Any], Coroutine[Any, Any, Response]]]] По умолчанию: None

Контактная информация для открытого API. Может содержать несколько полей:

Тип:Dict По умолчанию: None

Информация о лицензии открытого API. Может содержать несколько полей:

Тип:Dict По умолчанию: None

Ссылка к условиям пользования API.

Тип:Str По умолчанию: None

Префикс пути, обрабатываемый прокси, который не виден приложению, но виден внешними клиентами, что влияет на такие вещи, как пользовательский интерфейс Swagger.

Пример

from fastapi import FastAPI

app = FastAPI(root_path="/api/v1")

Тип: str: ''