Настройка Swagger UI

Вы можете настроить некоторые дополнительные параметры Swagger UI.

Чтобы их настроить, передайте аргумент swagger_ui_parameters при создании объекта приложения FastAPI() или в функцию get_swagger_ui_html().

swagger_ui_parameters принимает словарь с конфигурациями, переданными напрямую в Swagger UI.

FastAPI конвертирует конфигурации в JSON, чтобы сделать их совместимыми с JavaScript, так как именно это необходимо для Swagger UI.

Отключение подсветки синтаксиса

Например, вы можете отключить подсветку синтаксиса в Swagger UI.

Без изменения настроек, подсветка синтаксиса включена по умолчанию:

Но вы можете отключить её, установив syntaxHighlight в False:

{* ../../docs_src/configure_swagger_ui/tutorial001.py hl[3] *}

... и тогда Swagger UI больше не будет показывать подсветку синтаксиса:

Изменение темы

Таким же образом вы можете задать тему подсветки синтаксиса с помощью ключа "syntaxHighlight.theme" (обратите внимание, что в нём есть точка посередине):

{* ../../docs_src/configure_swagger_ui/tutorial002.py hl[3] *}

Эта конфигурация изменит цветовую тему подсветки синтаксиса:

Изменение параметров Swagger UI по умолчанию

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

Она включает в себя эти параметры по умолчанию:

{* ../../fastapi/openapi/docs.py ln[8:23] hl[17:23] *}

Вы можете переопределить любой из них, установив другое значение в аргументе swagger_ui_parameters.

Например, чтобы отключить deepLinking, вы можете передать эти настройки в swagger_ui_parameters:

{* ../../docs_src/configure_swagger_ui/tutorial003.py hl[3] *}

Другие параметры Swagger UI

Чтобы увидеть все возможные конфигурации, которые вы можете использовать, прочтите официальную документацию о параметрах Swagger UI.

Настройки только для JavaScript

Swagger UI также позволяет настроить другие параметры как объекты только для JavaScript (например, функции JavaScript).

FastAPI также включает эти настройки presets только для JavaScript:

presets: [
    SwaggerUIBundle.presets.apis,
    SwaggerUIBundle.SwaggerUIStandalonePreset
]

Это объекты JavaScript, а не строки, поэтому вы не можете передавать их напрямую из Python-кода.

Если вам нужно использовать конфигурации только для JavaScript, как эти, вы можете использовать один из методов, упомянутых выше. Переопределите всю path operation Swagger UI и вручную напишите любой необходимый JavaScript.

4.2 KiB Raw Blame History