3.2 KiB
Configurer Swagger UI
Vous pouvez configurer des paramètres supplémentaires de Swagger UI.
Pour les configurer, passez l'argument swagger_ui_parameters lors de la création de l'objet d'application FastAPI() ou à la fonction get_swagger_ui_html().
swagger_ui_parameters reçoit un dictionnaire avec les configurations passées directement à Swagger UI.
FastAPI convertit les configurations en JSON pour les rendre compatibles avec JavaScript, car c'est ce dont Swagger UI a besoin.
Désactiver la coloration syntaxique
Par exemple, vous pourriez désactiver la coloration syntaxique dans Swagger UI.
Sans modifier les paramètres, la coloration syntaxique est activée par défaut :
Mais vous pouvez la désactiver en définissant syntaxHighlight à False :
{* ../../docs_src/configure_swagger_ui/tutorial001_py310.py hl[3] *}
... et ensuite Swagger UI n'affichera plus la coloration syntaxique :
Modifier le thème
De la même manière, vous pouvez définir le thème de la coloration syntaxique avec la clé « syntaxHighlight.theme » (remarquez le point au milieu) :
{* ../../docs_src/configure_swagger_ui/tutorial002_py310.py hl[3] *}
Cette configuration modifierait le thème de couleurs de la coloration syntaxique :
Modifier les paramètres Swagger UI par défaut
FastAPI inclut des paramètres de configuration par défaut adaptés à la plupart des cas d'utilisation.
Il inclut ces configurations par défaut :
{* ../../fastapi/openapi/docs.py ln[9:24] hl[18:24] *}
Vous pouvez remplacer n'importe lequel d'entre eux en définissant une valeur différente dans l'argument swagger_ui_parameters.
Par exemple, pour désactiver deepLinking, vous pourriez passer ces paramètres à swagger_ui_parameters :
{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *}
Autres paramètres de Swagger UI
Pour voir toutes les autres configurations possibles que vous pouvez utiliser, lisez les documents officiels pour les paramètres de Swagger UI.
Paramètres JavaScript uniquement
Swagger UI permet également d'autres configurations qui sont des objets réservés à JavaScript (par exemple, des fonctions JavaScript).
FastAPI inclut aussi ces paramètres presets réservés à JavaScript :
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIBundle.SwaggerUIStandalonePreset
]
Ce sont des objets JavaScript, pas des chaînes, vous ne pouvez donc pas les passer directement depuis du code Python.
Si vous devez utiliser des configurations réservées à JavaScript comme celles-ci, vous pouvez utiliser l'une des méthodes ci-dessus. Surchargez entièrement le chemin d'accès Swagger UI et écrivez manuellement tout JavaScript nécessaire.