API ausprobieren!
Die Funktion PROBIER ES AUS! ermöglicht es Ihnen, Ihre API direkt in Ihrem Browser zu testen. Sie funktioniert sowohl in einem veröffentlichten Dokumentationsportal als auch direkt im Editor.
So konfigurieren Sie es
Die Funktion Probieren Sie es aus! verwendet die fetch API, daher müssen Ihre API-Importe Folgendes enthalten, damit sie funktioniert:
- eine absolute Pfad-URL zu Ihrer API (nicht nur ein Pfad)
- fügen Sie in Ihrer .yml-Datei eine URL wie folgt hinzu
- servers:
- URL-Beispiel: https://petstore3.swagger.io/api/v3 (Ihre tatsächliche URL)
- Autorisierungsmethoden werden aus Ihrer API-Datei gelesen und auf jeder API-Seite eingebunden
- CORS deaktiviert oder aktiviert für die Dokumentationsdomain, damit Benutzer Ihre API tatsächlich testen können
So funktioniert es
Importieren Sie Ihre API-Dateien (direkter Import oder GitHub-Synchronisierung)
[Optional] Definieren Sie "Standard"-Werte in Ihrer OpenAPI-Datei. Auf diese Weise werden beim Import Ihrer API alle "default"-Werte zum Codebeispiel hinzugefügt, und Sie können Ihre API sofort testen, ohne Werte manuell zu Parametern hinzufügen zu müssen.
Konfigurieren Sie die API-Methode mit den Testparametern
Nachdem Sie die Parameter aktualisiert haben, wird das Codebeispiel auf der rechten Seite (oder darunter, abhängig davon, wie Sie Ihre Ansicht eingestellt haben) ebenfalls mit den hinzugefügten Testparametern aktualisiert und liefert Ihnen den Codeausschnitt der Anfrage in mehreren Sprachen
Klicken Sie auf die Schaltfläche Probier es aus! und sehen Sie sich den Antwortbereich unterhalb des Beispielcodes an
