Allgemeines – How-To – Rezepte¶
Hier finden Sie mehrere Verweise auf andere Stellen in der Dokumentation, für allgemeine oder häufige Fragen.
Daten filtern – Sicherheit¶
Um sicherzustellen, dass Sie nicht mehr Daten zurückgeben, als Sie sollten, lesen Sie die Dokumentation unter Tutorial – Responsemodell – Rückgabetyp.
Dokumentations-Tags – OpenAPI¶
Um Tags zu Ihren Pfadoperationen hinzuzufügen und diese in der Oberfläche der Dokumentation zu gruppieren, lesen Sie die Dokumentation unter Tutorial – Pfadoperation-Konfiguration – Tags.
Zusammenfassung und Beschreibung in der Dokumentation – OpenAPI¶
Um Ihren Pfadoperationen eine Zusammenfassung und Beschreibung hinzuzufügen und diese in der Oberfläche der Dokumentation anzuzeigen, lesen Sie die Dokumentation unter Tutorial – Pfadoperation-Konfiguration – Zusammenfassung und Beschreibung.
Beschreibung der Response in der Dokumentation – OpenAPI¶
Um die Beschreibung der Response zu definieren, welche in der Oberfläche der Dokumentation angezeigt wird, lesen Sie die Dokumentation unter Tutorial – Pfadoperation-Konfiguration – Beschreibung der Response.
Pfadoperation in der Dokumentation deprecaten – OpenAPI¶
Um eine Pfadoperation zu deprecaten – sie als veraltet zu markieren – und das in der Oberfläche der Dokumentation anzuzeigen, lesen Sie die Dokumentation unter Tutorial – Pfadoperation-Konfiguration – Deprecaten.
Daten in etwas JSON-kompatibles konvertieren¶
Um Daten in etwas JSON-kompatibles zu konvertieren, lesen Sie die Dokumentation unter Tutorial – JSON-kompatibler Encoder.
OpenAPI-Metadaten – Dokumentation¶
Um Metadaten zu Ihrem OpenAPI-Schema hinzuzufügen, einschließlich einer Lizenz, Version, Kontakt, usw., lesen Sie die Dokumentation unter Tutorial – Metadaten und URLs der Dokumentationen.
Benutzerdefinierte OpenAPI-URL¶
Um die OpenAPI-URL anzupassen (oder zu entfernen), lesen Sie die Dokumentation unter Tutorial – Metadaten und URLs der Dokumentationen.
URLs der OpenAPI-Dokumentationen¶
Um die URLs zu aktualisieren, die für die automatisch generierten Dokumentations-Oberflächen verwendet werden, lesen Sie die Dokumentation unter Tutorial – Metadaten und URLs der Dokumentationen.