Importieren von OpenAPI / Swagger
Warum OpenAPI-Import verwenden?
Wenn Ihr Produkt für Entwickler entwickelt wurde oder Ihr Produkt über eine API verfügt, benötigen Sie großartige Produktdokumentation — andernfalls können Sie sich bei Entwicklern nicht durchsetzen.
Sobald Sie Ihre OpenAPI-Datei importieren, liest Archbee sie ein, konvertiert sie in eine ansprechende Benutzeroberfläche und macht sie bereit zum:
- Öffentlichen Teilen (auf einer benutzerdefinierten Domain)
- Internen Nutzung mit Ihren Kollegen und Teams
Nach dem Import können Sie Ihre OpenAPI synchronisieren, aktualisieren und testen. Weitere Details finden Sie in den folgenden Abschnitten.
Regeln und Standardeinstellungen
Importierte OpenAPI-Dateien können in Archbee nicht manuell bearbeitet werden.
Um Ihre OpenAPI zu aktualisieren und zu verwalten, prüfen Sie unsere Synchronisierungsoptionen
Unterstützte OpenAPI-Versionen:
Archbee unterstützt derzeit die folgenden OpenAPI-Versionen für den Import:
- Version 2.0 und 2.0.XX
- Version 3.0 und 3.0.XX
- Version 3.1 und 3.1.XX
Unterstützte Auth-Methoden
Archbee unterstützt derzeit die folgenden Auth-Methoden:
- API Keys
Wenn Sie OpenAPI-Dateien mit anderen Auth-Methoden importieren, werden diese korrekt importiert, und die Auth-Methode wird ignoriert.
Das bedeutet, dass Sie die gesamte Archbee OpenAPI-Erfahrung erhalten, außer der Try It!-Funktion, wenn Ihr Endpunkt eine oben nicht aufgeführte Auth erfordert.
Weitere Hinweise
- Wenn Sie in Ihrer OpenAPI "Standard"-Parameter definieren und ihnen einen Wert geben, werden das Codebeispiel und das Parameterfeld automatisch mit diesem Wert vorausgefüllt. Dies erleichtert es Ihren Nutzern oder Kunden, Ihre API mit Probier es aus! zu testen, ohne alle erforderlichen Parameter aktualisieren zu müssen.
- Wenn Sie in Ihrer OpenAPI einen "Beispiel"-Parameter definieren, wird der Beispielwert auf der linken Seite direkt unter dem API-Parameter angezeigt. Dies erleichtert es Ihren Nutzern zu erkennen, welche Art von Eingabe für diesen spezifischen Parameter benötigt wird.
Wie funktioniert es?
Importieren Sie Ihre OpenAPI-Datei über Inhalte importieren:
Oder verwenden Sie die Option Import in jedem Space:
Oder synchronisieren Sie Ihre OpenAPI-Dateien direkt aus Ihrem GitHub-Repository.
Mit Archbees GitHub-Integration können Sie Ihre OpenAPI-Dateien direkt aus Ihrem Repository hinzufügen und synchronisieren.
Vorschau und Test Ihrer importierten OpenAPI
Sehen Sie sich Ihre neu importierte OpenAPI mit Archbees API PROBIER ES AUS!-Funktion an und testen Sie sie.
Veröffentlichen oder teilen Sie es mit Ihren Kollegen oder Kunden!
Veröffentlichen Sie es in der Vorschau oder auf einer benutzerdefinierten Domain und machen Sie es Ihren Kollegen, Teams oder Nutzern zugänglich.
Wenn Sie den Inhalt schützen und nur mit ausgewählten Personen teilen möchten, sehen Sie sich unsere Optionen der Kontrollen für öffentlichen Zugriff für veröffentlichte Portale an.
Pflegen, synchronisieren und konfigurieren Sie es: