Importieren von OpenAPI / Swagger
7 min
warum den openapi‑import verwenden? wenn ihr produkt für entwickler entwickelt wurde oder ihr produkt eine api hat, benötigen sie großartige produktdokumentation — sonst erreichen sie entwickler nicht sobald sie ihre openapi datei importieren, liest archbee sie, wandelt sie in eine schöne benutzeroberfläche um und macht sie bereit für öffentliche freigabe (auf einer benutzerdefinierten domain) interne 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, sehen sie sich unsere synchronisierungsoptionen docid\ tdv9aargcevuwufmu1oqv 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 basis authentifizierung https //swagger io/docs/specification/authentication/basic authentication/ api schlüssel https //swagger io/docs/specification/authentication/api keys/ bearer authentifizierung https //swagger io/docs/specification/authentication/bearer authentication/ wenn sie openapi dateien mit anderen auth methoden importieren, werden sie 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 auth benötigt, die nicht in der obigen liste enthalten ist andere wenn sie „ standard “ parameter in ihrem openapi definieren und ihnen einen wert geben, werden das codebeispiel und das parameterfeld automatisch mit diesem wert vorausgefüllt dies macht es ihren nutzern oder kunden leicht, ihre api mit ausprobieren! docid\ uo3s5scjs02my 8rcufxh zu testen, ohne alle erforderlichen parameter aktualisieren zu müssen wenn sie einen " beispiel "‑parameter in ihrem openapi 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 erforderlich ist wie funktioniert es? importieren sie ihre openapi datei mit der inhalte importieren oder nutzen sie die option importieren in jedem space oder synchronisieren sie ihre openapi dateien direkt aus ihrem github docid\ aab0suip38at92h5rewuh repository mit archbees github integration docid\ aab0suip38at92h5rewuh können sie ihre openapi dateien direkt aus ihrem repository hinzufügen und synchronisieren vorschau und testen docid\ uo3s5scjs02my 8rcufxh ihrer importierten openapi sehen sie sich ihre neu importierte openapi mit archbees api ausprobieren! docid\ uo3s5scjs02my 8rcufxh 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 unter einer benutzerdefinierten domain und machen sie es ihren kollegen, teams oder nutzern zugänglich wenn sie die inhalte schützen und nur mit ausgewählten personen teilen möchten, sehen sie sich unsere optionen für öffentliche zugriffskontrollen docid\ lx0x8z ikcde5v6tshjkz für veröffentlichte portale an pflegen, synchronisieren und konfigurieren sie es manuell synchronisieren docid\ tdv9aargcevuwufmu1oqv automatisch über api synchronisieren docid\ tdv9aargcevuwufmu1oqv beispielcodelanguage ändern docid\ tdv9aargcevuwufmu1oqv hier ist ein video, das zeigt, wie es funktioniert
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.
