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 eine großartige Produktdokumentation — andernfalls erreichen Sie Entwickler nicht.
Sobald Sie Ihre OpenAPI-Datei importieren, liest Archbee sie ein, konvertiert sie in eine ansprechende UI und bereitet sie darauf vor, wie folgt verwendet zu werden:
- Öffentlich geteilt (auf einer benutzerdefinierten Domain)
- Intern 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 geändert werden.
Um Ihre OpenAPI zu aktualisieren und zu verwalten, lesen 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:
Wenn Sie OpenAPI-Dateien mit anderen Auth-Methoden importieren, werden sie korrekt importiert und die Auth-Methode wird ignoriert.
Das bedeutet, dass Sie das vollständige Archbee-OpenAPI-Erlebnis erhalten, außer der Try It!-Funktion, wenn Ihr Endpunkt eine Authentifizierung erfordert, die nicht in der obigen Liste enthalten ist.
Sonstiges
- Wenn Sie in Ihrer OpenAPI einen "Standard"-Parameter definieren und ihm einen Wert zuweisen, werden das Codebeispiel und das Parameterfeld automatisch mit diesem Wert vorausgefüllt. Dadurch können Ihre Benutzer oder Kunden Ihre API mit Ausprobieren! 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. Dadurch können Ihre Benutzer leichter erkennen, welche Art von Eingabe für diesen speziellen Parameter erforderlich ist.
Wie funktioniert das?
Importieren Sie Ihre OpenAPI-Datei mit Inhalt importieren:
Oder verwenden Sie die Option Importieren in jedem Bereich:
Oder synchronisieren Sie Ihre OpenAPI-Dateien direkt aus Ihrem GitHub-Repository.
Mit der Github-Integration von Archbee können Sie Ihre OpenAPI-Dateien direkt aus Ihrem Repo hinzufügen und synchronisieren.
Zeigen Sie eine Vorschau an und testen Sie Ihre importierte OpenAPI
Zeigen Sie eine Vorschau an und testen Sie Ihre neu importierte OpenAPI mit der Funktion API TESTEN! von Archbee.
Veröffentlichen oder teilen Sie es mit Ihren Kollegen oder Kunden!
Veröffentlichen Sie es in Preview oder auf einer Custom Domain und machen Sie es für Ihre Kollegen, Teams oder Benutzer verfügbar.
Wenn Sie die Inhalte schützen und nur mit ausgewählten Personen teilen möchten, sehen Sie sich unsere Öffentliche Zugriffskontrollen-Optionen für veröffentlichte Portale an.
Verwalten, synchronisieren und konfigurieren Sie es: