Citrix Application Delivery Management-Service

Erstellen oder Hochladen einer API-Definition

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 ADM API-Definitionen hinzufügen und sie dann auf einem API-Gateway (Citrix ADC) bereitstellen.

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

Hinweis

Derzeit unterstützt ADM das Parsen von OAS-Spezifikationsdateien, die Swagger 2.0 oder Openapi 3.0.1verwenden.

Laden Sie die OAS-Spezifikation hoch

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

  1. Navigieren Sie zu Anwendungen > API Gateway > 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 ADM Swagger Version 2.0.

  4. Durchsuchen Sie eine OAS-Spezifikation von Ihrem lokalen Computer und laden Sie sie zu ADM hoch.

Erstellen einer API-Definition

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

  1. Navigieren Sie zu Anwendungen > API Gateway > 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 Domainnamen 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.

    Erstellen einer API-Definition

  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.

Als Nächstes stellen Sie diese Definition auf einem API-Gateway bereit.

Erstellen oder Hochladen einer API-Definition