Importieren von OpenAPI / Swagger
7 min
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 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 basic authentication https //swagger io/docs/specification/authentication/basic authentication/ api keys https //swagger io/docs/specification/authentication/api keys/ bearer authentication https //swagger io/docs/specification/authentication/bearer authentication/ 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! docid\ uo3s5scjs02my 8rcufxh 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 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 test docid\ uo3s5scjs02my 8rcufxh ihrer importierten openapi sehen sie sich ihre neu importierte openapi mit archbees api probier es aus! 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 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 docid\ lx0x8z ikcde5v6tshjkz für veröffentlichte portale an pflegen, synchronisieren und konfigurieren sie es manuell synchronisieren docid\ tdv9aargcevuwufmu1oqv automatisch über die api synchronisieren docid\ tdv9aargcevuwufmu1oqv sprache des beispielcodes ändern docid\ tdv9aargcevuwufmu1oqv hier ist ein video, 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.