Wie benutzt man Swagger?

Pläne, die den Zugriff auf API-Token-Einstellungen im Wissensdatenbank-Portal unterstützen

Swagger ist eine Sprache zur Beschreibung von Schnittstellen, die RESTful-APIs beschreibt, die mit JSON ausgedrückt werden. Es ermöglicht Ihnen, interaktive, maschinen- und menschenlesbare API-Dokumentationen zu erstellen. Es hilft Ihnen, die Ressourcen der API ohne Implementierungslogik zu visualisieren und mit ihnen zu interagieren. Es handelt sich um eine webbasierte Anwendung.

Swagger-Dokumentationsseite

1. Öffnen Sie die Swagger-Dokumentationsseite.

2. Um die Dokumentation zu authentifizieren, klicken Sie auf Autorisieren.
   Der Bereich Verfügbare Berechtigungen wird angezeigt.

3. Geben Sie das API-Token in das Feld Wert ein.

   ANMERKUNG

   Sie können ein vorhandenes Token auswählen oder ein neues Token gemäß Ihren Anforderungen generieren. Um ein neues Token zu generieren, führen Sie die folgenden Schritte aus

   • Wechseln Sie im Knowledge Base-Portal zu Einstellungen > API-Token .

   • Geben Sie einen Namen für das API-Token in das Feld Geben Sie den Tokennamen ein.

   • Wählen Sie die gewünschte(n) HTTP-Methode(n) aus. Unter Zulässige Methode(n) stehen Ihnen vier Methoden zur Verfügung: GET, PUT, POST und DELETE.

   • Sie können das generierte Token nur für die ausgewählte(n) Methode(n) verwenden. Es kann nicht verwendet werden, um andere Methoden auszuführen.

   • Klicken Sie auf Kopieren , um das API-Token zu kopieren.

4. Klicken Sie auf die Schaltfläche Autorisieren .

5. Wenn Sie fertig sind, klicken Sie auf die Schaltfläche Schließen .
   Die Autorisierung wurde erfolgreich durchgeführt.

   

   ANMERKUNG

   Wenn Sie zu einem anderen Token wechseln möchten, klicken Sie auf Authorize > Logout > geben Sie Ihr API-Token ein > Authorize > Close.

ERHALTEN

• Die GET-Methode wird zum Abrufen von Informationen verwendet.

• Nachfolgend finden Sie ein Beispiel für eine GET-Aktion zum Abrufen aller Datensätze über das Teamkonto.

1. Füllen Sie die markierten Felder aus und klicken Sie auf die Schaltfläche Ausführen .

   Die Informationen zum Team-Konto sind im Abschnitt "Antworten " verfügbar.

BEREITSTELLEN

• Die POST-Methode wird verwendet, um ein Element hinzuzufügen.

• Im Folgenden finden Sie ein Beispiel für eine POST-Aktion , um einem Projekt ein Teamkonto hinzuzufügen.

1. Sie sollten die Teamkontoinformationen wie email_id, first_name und last_name hinzufügen, um dem Projekt einen Benutzer hinzuzufügen.
   Das Teamkonto wird dem Projekt hinzugefügt.

2. Klicken Sie auf die Schaltfläche Ausführen .
   Das Hinzufügen des Teamkontos ist erfolgreich, wenn der Status 200 und der Erfolg wahr ist.

STELLEN

• Die PUT-Methode wird verwendet, um ein vorhandenes Element zu aktualisieren.

• Nachfolgend finden Sie ein Beispiel für eine PUT-Aktion zum Aktualisieren einer Benutzerrolle im Projekt.

1. Geben Sie die userId in das markierte Feld ein.

2. Aktualisieren Sie die Benutzerrolle mit der Nummer, die für die Syntax der Benutzerrolle angegeben ist. Die Zahlen für die jeweiligen Rollen lauten wie folgt:

   • 1 → Administrator

   • 2 → Editor

   • 3 → Entwurfsschreiber

   • 4 → Lesegerät

   • 7 → Besitzer

3. Wenn Sie fertig sind, klicken Sie auf die Schaltfläche Ausführen .

   Die Aktualisierung des Benutzers ist erfolgreich, wenn der Status 200 und der Erfolg wahr ist.

LÖSCHEN

• Die DELETE-Methode wird verwendet, um ein Element zu löschen.

• Nachfolgend finden Sie ein Beispiel für eine DELETE-Aktion zum Löschen einer Benutzer-ID.

1. Geben Sie die userId in das markierte Feld ein.

2. Wenn Sie fertig sind, klicken Sie auf die Schaltfläche Ausführen .
   Wenn der Status 200 und der Erfolg true ist, wird die userId erfolgreich gelöscht.

   

ANMERKUNG

Es ist zwingend erforderlich, die Inhalte in die Felder einzugeben, die mit *erforderlich gekennzeichnet sind.

 Weitere Informationen finden Sie in den folgenden Blogs

1. Ultimativer Leitfaden zum Erstellen einer API-Dokumentation mit Beispielen

2. Feature spotlight – API in Document360

   ---

   Häufig gestellte Fragen

   Was soll ich tun, wenn das Aktualisieren der Seite meine Sitzung beendet?

   Wenn Sie die Seite aktualisieren, wird die Sitzung möglicherweise beendet, und Sie müssen sich erneut authentifizieren. Befolgen Sie die für die Authentifizierung angegebenen Schritte.

   Wie formatiere ich Felder, die ein bestimmtes Zeichen erfordern?

   Sie müssen bei Bedarf einen Unterstrich verwenden. Verwenden Sie beispielsweise "email_id" anstelle von "E-Mail-ID". Die Verwendung von Leerzeichen führt zu einem Fehler.