committed by
GitHub
1 changed files with 87 additions and 0 deletions
@ -0,0 +1,87 @@ |
|||||
|
# OpenAPI erweitern |
||||
|
|
||||
|
In einigen Fällen müssen Sie möglicherweise das generierte OpenAPI-Schema ändern. |
||||
|
|
||||
|
In diesem Abschnitt erfahren Sie, wie. |
||||
|
|
||||
|
## Der normale Vorgang |
||||
|
|
||||
|
Der normale (Standard-)Prozess ist wie folgt. |
||||
|
|
||||
|
Eine `FastAPI`-Anwendung (-Instanz) verfügt über eine `.openapi()`-Methode, von der erwartet wird, dass sie das OpenAPI-Schema zurückgibt. |
||||
|
|
||||
|
Als Teil der Erstellung des Anwendungsobjekts wird eine *Pfadoperation* für `/openapi.json` (oder welcher Wert für den Parameter `openapi_url` gesetzt wurde) registriert. |
||||
|
|
||||
|
Diese gibt lediglich eine JSON-Response zurück, mit dem Ergebnis der Methode `.openapi()` der Anwendung. |
||||
|
|
||||
|
Standardmäßig überprüft die Methode `.openapi()` die Eigenschaft `.openapi_schema`, um zu sehen, ob diese Inhalt hat, und gibt diesen zurück. |
||||
|
|
||||
|
Ist das nicht der Fall, wird der Inhalt mithilfe der Hilfsfunktion unter `fastapi.openapi.utils.get_openapi` generiert. |
||||
|
|
||||
|
Und diese Funktion `get_openapi()` erhält als Parameter: |
||||
|
|
||||
|
* `title`: Der OpenAPI-Titel, der in der Dokumentation angezeigt wird. |
||||
|
* `version`: Die Version Ihrer API, z. B. `2.5.0`. |
||||
|
* `openapi_version`: Die Version der verwendeten OpenAPI-Spezifikation. Standardmäßig die neueste Version: `3.1.0`. |
||||
|
* `summary`: Eine kurze Zusammenfassung der API. |
||||
|
* `description`: Die Beschreibung Ihrer API. Dies kann Markdown enthalten und wird in der Dokumentation angezeigt. |
||||
|
* `routes`: Eine Liste von Routen, dies sind alle registrierten *Pfadoperationen*. Sie stammen von `app.routes`. |
||||
|
|
||||
|
!!! info |
||||
|
Der Parameter `summary` ist in OpenAPI 3.1.0 und höher verfügbar und wird von FastAPI 0.99.0 und höher unterstützt. |
||||
|
|
||||
|
## Überschreiben der Standardeinstellungen |
||||
|
|
||||
|
Mithilfe der oben genannten Informationen können Sie dieselbe Hilfsfunktion verwenden, um das OpenAPI-Schema zu generieren und jeden benötigten Teil zu überschreiben. |
||||
|
|
||||
|
Fügen wir beispielsweise <a href="https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo" class="external-link" target="_blank">ReDocs OpenAPI-Erweiterung</a> zum Einbinden eines benutzerdefinierten Logos hinzu. |
||||
|
|
||||
|
### Normales **FastAPI** |
||||
|
|
||||
|
Schreiben Sie zunächst wie gewohnt Ihre ganze **FastAPI**-Anwendung: |
||||
|
|
||||
|
```Python hl_lines="1 4 7-9" |
||||
|
{!../../../docs_src/extending_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Das OpenAPI-Schema generieren |
||||
|
|
||||
|
Verwenden Sie dann dieselbe Hilfsfunktion, um das OpenAPI-Schema innerhalb einer `custom_openapi()`-Funktion zu generieren: |
||||
|
|
||||
|
```Python hl_lines="2 15-21" |
||||
|
{!../../../docs_src/extending_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Das OpenAPI-Schema ändern |
||||
|
|
||||
|
Jetzt können Sie die ReDoc-Erweiterung hinzufügen und dem `info`-„Objekt“ im OpenAPI-Schema ein benutzerdefiniertes `x-logo` hinzufügen: |
||||
|
|
||||
|
```Python hl_lines="22-24" |
||||
|
{!../../../docs_src/extending_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Zwischenspeichern des OpenAPI-Schemas |
||||
|
|
||||
|
Sie können die Eigenschaft `.openapi_schema` als „Cache“ verwenden, um Ihr generiertes Schema zu speichern. |
||||
|
|
||||
|
Auf diese Weise muss Ihre Anwendung das Schema nicht jedes Mal generieren, wenn ein Benutzer Ihre API-Dokumentation öffnet. |
||||
|
|
||||
|
Es wird nur einmal generiert und dann wird dasselbe zwischengespeicherte Schema für die nächsten Requests verwendet. |
||||
|
|
||||
|
```Python hl_lines="13-14 25-26" |
||||
|
{!../../../docs_src/extending_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Die Methode überschreiben |
||||
|
|
||||
|
Jetzt können Sie die Methode `.openapi()` durch Ihre neue Funktion ersetzen. |
||||
|
|
||||
|
```Python hl_lines="29" |
||||
|
{!../../../docs_src/extending_openapi/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Testen |
||||
|
|
||||
|
Sobald Sie auf <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a> gehen, werden Sie sehen, dass Ihr benutzerdefiniertes Logo verwendet wird (in diesem Beispiel das Logo von **FastAPI**): |
||||
|
|
||||
|
<img src="/img/tutorial/extending-openapi/image01.png"> |
Loading…
Reference in new issue