API Ausprobieren!
Die Probier es aus! Funktion ermöglicht es Ihnen, Ihre API direkt in Ihrem Browser zu testen. Sie funktioniert sowohl auf einem veröffentlichten Doc-Portal als auch direkt im Editor.
Wie man sie konfiguriert
Die Probier es aus! Funktion verwendet die fetch API, daher müssen Ihre API-Imports Folgendes enthalten, damit sie funktioniert:
- eine absolute Pfad-URL zu Ihrer API (nicht nur ein Pfad)
- fügen Sie 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 ausgelesen und in jede API-Seite eingebunden
- CORS deaktiviert oder aktiviert für die Dokumentationsdomain, damit Benutzer Ihre API tatsächlich testen können
Wie es funktioniert
Importieren Sie Ihre API-Dateien (direkter Import oder GitHub-Synchronisierung)
[Optional] Definieren Sie „default“ Werte in Ihrer OpenAPI-Datei. Auf diese Weise werden beim Import Ihrer API alle „default“-Werte dem Codebeispiel hinzugefügt, und Sie können Ihre API sofort testen, ohne die Werte manuell zu den Parametern hinzufügen zu müssen.
Konfigurieren Sie die API-Methode mit den Testparametern
Nachdem Sie die Parameter aktualisiert haben, wird das Codebeispiel rechts (oder unten, je nach Ansicht) ebenfalls mit den hinzugefügten Testparametern aktualisiert und stellt Ihnen den Request-Code-Snippet in mehreren Sprachen bereit
Klicken Sie auf die Probier es aus! Schaltfläche und überprüfen Sie den Antwortbereich unterhalb des Beispielcodes
