API-Definition erstellen und hochladen

Eine API-Definition ist ein Dokument, das eine API beschreibt, die die OpenAPI-Spezifikationsstandards (Swagger 2.0, OpenAPI 3.0.x) verwendet. Diese Definition kann API-Ressourcenpfade und -methoden enthalten, um sie zu bedienen. Sie können API-Definitionen zur NetScaler Console hinzufügen und sie dann auf einem API-Gateway (NetScaler) bereitstellen.

Sie können API-Definitionen auf eine der folgenden Arten erstellen:

• Laden Sie die Swagger OAS-Spezifikationsdatei hoch
• Erstellen Sie Ihre eigene API-Definition

Hinweis:

Derzeit unterstützt NetScaler Console das Parsen von OAS-Spezifikationsdateien, die Swagger 2.0 oder openapi 3.0.1 verwenden.

Laden Sie die OAS-Spezifikation hoch

Sie können die OAS-Spezifikation auf die NetScaler Console-GUI hochladen.

1. Navigieren Sie zu Sicherheit > API-Sicherheit > API-Definitionen.

2. Klicken Sie auf Hinzufügen.

3. Wählen Sie OAS-Spezifikation hochladenaus.

   Hinweis:

   Stellen Sie sicher, dass die OAS-Spezifikationsdatei im YAML- oder JSON-Format vorliegt. Und diese Datei darf keine externen Referenzen enthalten. Derzeit unterstützt NetScaler Console Swagger Version 2.0.

4. Durchsuchen Sie eine OAS-Spezifikation von Ihrem lokalen Computer aus und laden Sie sie auf NetScaler Console hoch.

Erstellen einer API-Definition

Sie können Ihre eigene API-Definition in der NetScaler Console-GUI erstellen.

1. Navigieren Sie zu Sicherheit > API-Sicherheit > API-Definitionen.

2. Klicken Sie auf Hinzufügen.

3. Wählen Sie Create Your Definition und geben Sie Folgendes an:

   • Name - Ein Name für die API-Definition.

   • API-Definition - Eine Definition muss Titel, Version, Basispfad und Host enthalten. Sie können einen Domänennamen oder eine IP-Adresse im Feld Host angeben.

   • API-Ressourcen - Fügen Sie Ihrer Definition mehrere API-Ressourcen hinzu. Jede Ressource hat einen Pfad und eine unterstützte Methode. Klicken Sie auf Hinzufügen. Die Ressource wird der Tabelle Hinzugefügte Ressourcen hinzugefügt . Klicken Sie auf Löschen, um eine API-Ressource zu löschen.

   

4. Klicken Sie auf Erstellen.

API-Definitionen anzeigen

Auf der Seite “ API-Definitionen “ wird die hochgeladene Definition aufgeführt. Klicken Sie auf Ansicht, um die folgenden API-Definitionsdetails anzuzeigen:

• Name — Zeigt den Namen einer API-Definition an.

• API-Definition — Zeigt Titel, Version, Basispfad und Host einer Definition an.

• API-Ressourcen — Listet die API-Ressourcen in einer API-Definition und ihre Methoden zum Betrieb auf.