Browse Source

Update how-to/configure-swagger-ui.md

pull/14015/head
Nils Lindemann 2 weeks ago
parent
commit
6dac9e3609
  1. 16
      docs/de/docs/how-to/configure-swagger-ui.md

16
docs/de/docs/how-to/configure-swagger-ui.md

@ -1,4 +1,4 @@
# Swagger-Oberfläche konfigurieren
# Swagger-Oberfläche konfigurieren { #configure-swagger-ui }
Sie können einige zusätzliche <a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/" class="external-link" target="_blank">Parameter der Swagger-Oberfläche</a> konfigurieren.
@ -8,7 +8,7 @@ Um diese zu konfigurieren, übergeben Sie das Argument `swagger_ui_parameters` b
FastAPI konvertiert die Konfigurationen nach **JSON**, um diese mit JavaScript kompatibel zu machen, da die Swagger-Oberfläche das benötigt.
## Syntaxhervorhebung deaktivieren
## Syntaxhervorhebung deaktivieren { #disable-syntax-highlighting }
Sie könnten beispielsweise die Syntaxhervorhebung in der Swagger-Oberfläche deaktivieren.
@ -24,9 +24,9 @@ Sie können sie jedoch deaktivieren, indem Sie `syntaxHighlight` auf `False` set
<img src="/img/tutorial/extending-openapi/image03.png">
## Das Theme ändern
## Das Theme ändern { #change-the-theme }
Auf die gleiche Weise könnten Sie das Theme der Syntaxhervorhebung mit dem Schlüssel `syntaxHighlight.theme` festlegen (beachten Sie, dass er einen Punkt in der Mitte hat):
Auf die gleiche Weise könnten Sie das Theme der Syntaxhervorhebung mit dem Schlüssel `"syntaxHighlight.theme"` festlegen (beachten Sie, dass er einen Punkt in der Mitte hat):
{* ../../docs_src/configure_swagger_ui/tutorial002.py hl[3] *}
@ -34,13 +34,13 @@ Obige Konfiguration würde das Theme für die Farbe der Syntaxhervorhebung ände
<img src="/img/tutorial/extending-openapi/image04.png">
## Defaultparameter der Swagger-Oberfläche ändern
## Defaultparameter der Swagger-Oberfläche ändern { #change-default-swagger-ui-parameters }
FastAPI enthält einige Defaultkonfigurationsparameter, die für die meisten Anwendungsfälle geeignet sind.
Es umfasst die folgenden Defaultkonfigurationen:
{* ../../fastapi/openapi/docs.py ln[7:23] *}
{* ../../fastapi/openapi/docs.py ln[8:23] hl[17:23] *}
Sie können jede davon überschreiben, indem Sie im Argument `swagger_ui_parameters` einen anderen Wert festlegen.
@ -48,11 +48,11 @@ Um beispielsweise `deepLinking` zu deaktivieren, könnten Sie folgende Einstellu
{* ../../docs_src/configure_swagger_ui/tutorial003.py hl[3] *}
## Andere Parameter der Swagger-Oberfläche
## Andere Parameter der Swagger-Oberfläche { #other-swagger-ui-parameters }
Um alle anderen möglichen Konfigurationen zu sehen, die Sie verwenden können, lesen Sie die offizielle <a href="https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/" class="external-link" target="_blank">Dokumentation für die Parameter der Swagger-Oberfläche</a>.
## JavaScript-basierte Einstellungen
## JavaScript-basierte Einstellungen { #javascript-only-settings }
Die Swagger-Oberfläche erlaubt, dass andere Konfigurationen auch **JavaScript**-Objekte sein können (z. B. JavaScript-Funktionen).

Loading…
Cancel
Save