Eine API-Referenz erstellen
Erstellen Sie in Ihrem Help Center eine API-Referenz aus einer OpenAPI-, Swagger-2.0-, GraphQL-SDL- oder GraphQL-Introspektions-JSON-Spezifikation. Sie können eine Datei hochladen, die Spezifikation aus einem GitHub-Repository lesen oder sie von einer URL abrufen. Zum Erstellen und Veröffentlichen einer API-Referenz ist ein aktives oder Testabonnement erforderlich, und Spezifikationsdateien dürfen höchstens 15 MB groß sein.
Eine API-Referenz hinzufügen
Gehen Sie im Dashboard zur Seite Help Center.
Klicken Sie in einer Abschnittsüberschrift auf die Schaltfläche zum Hinzufügen von Inhalten und wählen Sie API-Referenz erstellen.
Wählen Sie im Dialog API-Referenz hinzufügen eine Quelle aus: Datei hochladen, Von GitHub oder Von einer URL.
Eine Spezifikationsdatei hochladen
Beim Hochladen werden OpenAPI-JSON- oder YAML-Dateien sowie GraphQL-Schemadateien mit der Erweiterung .graphql, .gql oder .graphqls akzeptiert. Wählen Sie Datei hochladen und wählen Sie Ihre Spezifikationsdatei aus.
Eine Spezifikation von einer URL hinzufügen
Verwenden Sie diese Option, wenn Ihre Spezifikation bereits online gehostet wird. Die URL kann auf ein OpenAPI-Dokument, eine GraphQL-SDL-Datei oder einen GraphQL-Endpunkt verweisen.
Wählen Sie Von einer URL.
Geben Sie die URL Ihrer Spezifikation oder Ihres GraphQL-Endpunkts ein.
Für GraphQL-Endpunkte muss die Introspektion aktiviert sein. URL-Quellen werden alle sechs Stunden automatisch aktualisiert.
Wenn Ihre Spezifikations-URL von Stainless stammt, können die generierten Seiten SDK-Codeausschnitte anzeigen.
Eine Spezifikation von GitHub hinzufügen
Lesen Sie die Spezifikationsdatei bei jeder Synchronisierung direkt aus einem Repository. Die GitHub-Verbindung muss zum selben Workspace gehören und Zugriff auf das Repository haben.
Wählen Sie Von GitHub.
Wählen Sie eine GitHub-Verbindung aus. Wenn Sie GitHub noch nicht verbunden haben, richten Sie dies zuerst unter GitHub-Integration ein.
Wählen Sie das Repository aus.
Optional können Sie einen Branch oder Commit auswählen. Wenn verfügbar, wird der konfigurierte Produktions-Branch verwendet. Andernfalls wird der GitHub-Standard-Branch des Repositorys verwendet.
Geben Sie den relativ zum Repository angegebenen Pfad zur Spezifikationsdatei ein.
Klicken Sie auf Spezifikation prüfen und warten Sie, bis die Prüfung erfolgreich abgeschlossen ist.
Die Spezifikationsprüfung muss erfolgreich sein, bevor Sie die API-Referenz aus GitHub erstellen können.
Konfigurieren und erstellen
Geben Sie einen URL-Slug für die Referenz ein.
Wählen Sie aus, ob Sofort veröffentlichen verwendet werden soll.
Klicken Sie auf API-Referenz hinzufügen.
Die Verarbeitung dauert in der Regel einige Sekunden. Sobald die Spezifikation bereit ist, wird Ihre API-Referenz ist bereit angezeigt. Klicken Sie auf Fertig, um den Vorgang abzuschließen. Wenn die Verarbeitung fehlschlägt, wird Verarbeitung fehlgeschlagen angezeigt. Klicken Sie auf Schließen, um den Dialog zu schließen.
Wie geht es weiter?
Halten Sie die Quelle unter Spezifikation einer API-Referenz ersetzen und Quellen von API-Referenzen aktualisieren aktuell, und passen Sie die Seitenleiste und die Operationsseiten unter API-Referenz anpassen an.