API-Definition erstellen oder hochladen

Eine API-Definition ist ein Dokument, das eine API unter Verwendung der OpenAPI-Spezifikationsstandards beschreibt. Diese Definition kann API-Ressourcenpfade und Methoden zu deren Betrieb enthalten. Sie können API-Definitionen zur NetScaler Console hinzufügen und diese dann auf einem API-Gateway (NetScaler) bereitstellen.

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

• Swagger OAS-Spezifikationsdatei hochladen
• Eigene API-Definition erstellen

Hinweis:

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

OAS-Spezifikation hochladen

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

1. Navigieren Sie zu Security > API Security > API Definitions.

2. Klicken Sie auf Add.

3. Wählen Sie Upload OAS Specification aus.

   Hinweis:

   Stellen Sie sicher, dass die OAS-Spezifikationsdatei im YAML- oder JSON-Format vorliegt. Und diese Datei darf keine externen Referenzen enthalten.

4. Suchen Sie eine OAS-Spezifikation auf Ihrem lokalen Computer und laden Sie sie in die NetScaler Console hoch.

Eine API-Definition erstellen

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

1. Navigieren Sie zu Security > API Security > API Definitions.

2. Klicken Sie auf Add.

3. Wählen Sie Create Your Definition aus 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 Add. Die Ressource wird der Tabelle Added Resources hinzugefügt. Klicken Sie auf Delete, um eine API-Ressource zu löschen.

   

4. Klicken Sie auf Create.

API-Definitionen anzeigen

Die Seite API Definitions listet die hochgeladene Definition auf. Klicken Sie auf View, um die folgenden Details der API-Definition 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 deren Methoden zu deren Betrieb auf.