Produktdokumentation
ADC
14.1 - Current Release 13.1 13.0 12.1
PDF anzeigen

API-Spezifikation importieren

June 13, 2024
Beitrag von: 
C

Die API-Spezifikation definiert das Design einer API, einschließlich Endpunkten, Methoden, Parametern und Datenformaten. Mit der Funktion API-Spezifikation importieren können Sie die offene API-Spezifikation importieren, die im Allgemeinen zur Beschreibung der REST-API verwendet wird. Wenn die Web App Firewall eine Überprüfung der Anfrage eines Benutzers für einen API-basierten Webdienst durchführt, validiert sie die Anfrage anhand des Schemas, das in der API-Spezifikationsdatei für diesen Webdienst angegeben ist. NetScaler unterstützt Schemavalidierungen für eine REST-API, wobei die Nutzlast Anwendungs-JSON und ProtoBuf für gRPC-API-Anfragen ist.

NetScaler unterstützt die folgenden Spezifikationsformate:

  • API öffnen - Swagger 2.0, OAS 3.0,3.1
  • ProtoBuf - v3 und v2

API-Spezifikationsdateien verwalten

Sie können eingehenden API-Verkehr anhand der importierten API-Spezifikation validieren, indem Sie ihn einem Profil zuweisen und eine Entspannungsregel festlegen, um den Datenverkehr entweder zu blockieren oder zuzulassen. Das Importieren einer API-Spezifikation besteht aus zwei Schritten:

  1. API-Spezifikation importieren − Importiert eine API-Spezifikation über eine URL oder aus dem System in NetScaler.
  2. Fügen Sie die API-Spezifikation zu NetScaler hinzu − Wenn Sie eine API-Spezifikation zu NetScaler hinzufügen, wird die Datei validiert, in ein internes Format konvertiert und eine API-Spezifikationsentität wird erstellt. Die erstellte API-Spezifikationsentität wird in Richtlinienausdrücken und Web App Firewall-Profilen verwendet.

Hinweis:

Stellen Sie sicher, dass die hochgeladenen Open API Swagger 2.0-, OAS 3.0- und 3.1-Spezifikationsdateien keine Verweise auf externe Dateien enthalten. Wenn Sie Details aus einer externen Datei verwenden müssen, konsolidieren Sie die Informationen mithilfe von Open-Source-Tools in einer einzigen Datei und laden Sie sie dann hoch.

API-Spezifikationsdateien mit der CLI verwalten

Die folgenden Parameter werden in den CLI-Befehlen verwendet:

  • Name − Name der API-Spezifikationsdatei, die hochgeladen wird.
  • Quelle − URL (Protokoll, Host, Pfad und Name) für den Speicherort der importierten Spezifikationsdatei.
  • Spezifikationsname − Der Name der Entität, die aus der hochgeladenen API-Spezifikation erstellt wurde.
  • Typ − Eingabeformat der API-Spezifikation. Standardwert: OAS

Um eine API-Spezifikationsdatei zu importieren, geben Sie Folgendes ein:

import api specFile <name> <src>

Beispiel:
import apispec testapispec.json http://www.example.com/testapispec.json

Um eine API-Spezifikationsdatei hinzuzufügen, geben Sie Folgendes ein:

add api spec <Name> -File <string> -Type <string>

Beispiel:
add api spec testapispec -File testapispec.json -Type OAS

Um eine API-Spezifikationsdatei zu aktualisieren, importieren Sie eine neue Spezifikationsdatei, die aktualisiert werden muss.

Geben Sie in der Befehlszeile Folgendes ein:

update api spec <specName> -File <string> -Type <string>

Beispiel:
update api spec testapispec -File testapispec.json -Type OAS

Hinweis:

Wenn das Typattribut nicht angegeben ist, ist OAS der Standardtyp.

Um alle Endpoints anzuzeigen, geben Sie Folgendes ein:

show api spec <specName>

Beispiel:

show api spec testapispec

Um die API-Spezifikation zu löschen, geben Sie Folgendes ein:

rm api spec <specName>

Beispiel:

rm api spec testapispec

Hinweis:

Bevor Sie die API-Spezifikation entfernen, stellen Sie sicher, dass sie von keinem Profil oder keiner Richtlinie verwendet wird.

API-Spezifikationsdateien mit der GUI verwalten

  1. Navigieren Sie zu Sicherheit > NetScaler Web App Firewall > Importe.
  2. Wählen Sie auf der Seite Importe die Registerkarte API-Spezifikations-Importseite aus, und klicken Sie dann auf Hinzufügen.
  3. Wählen Sie auf der Seite “ API-Spezifikations-Objekt importieren “ eine der folgenden Optionen für den Parameter Import From aus :
    1. URL: Eine Web-URL auf einer Website, auf die die Appliance zugreifen kann.
    2. Datei: Eine Datei auf einer lokalen oder Netzwerkfestplatte oder einem anderen Speichergerät.
  4. Klicken Sie auf Weiter.
  5. Geben Sie auf der Seite “ API-Spezifikationsimport-Objekt “ die folgenden Details ein:
    1. API-Spezifikationsname − Der Name der Entität, die aus der hochgeladenen API-Spezifikation erstellt wird. Hinweis: Sowohl der API-Dateiname als auch der eingegebene API-Spezifikationsname sollten identisch sein.

    2. API-Spezifikationstyp − Wählen Sie den Spezifikationstyp aus.

      Typen: REST (OpenAPI/Swagger) und gRPC (PROTO).

      Standardtyp: REST (OpenAPI/Swagger)

    3. Klicken Sie auf Fertig.

Die neu hinzugefügte Entität wird auf der Seite Importe auf der Registerkarte API-Spezifikations-Importseiteaufgeführt.

Sehen Sie sich die Statistiken der API-Spezifikation und der API-Endpunkte an

Sie können die folgenden Statistiken für alle API-Spezifikationen und API-Endpunkte einsehen:

  • Treffer bei den API-Spezifikationen − Anfragen, die einem beliebigen Endpunkt der API-Spezifikation entsprechen.
  • Erfolgreiche Validierungen der API-Spezifikation − Anfragen, die einem beliebigen Endpunkt der API-Spezifikation entsprechen und dem API-Schema entsprechen.
  • Anfragen ohne Übereinstimmung in der API-Spezifikation − Anfragen, die keinem Endpunkt der API-Spezifikation entsprechen.
  • API-Endpunkt-Treffer − Anfragen, die einem bestimmten Endpunkt entsprechen.
  • Erfolgreiche Validierungen von API-Endpunkten − Anfragen, die einem bestimmten Endpunkt entsprechen und dem API-Schema entsprechen.

API-Spezifikationen und API-Endpunktstatistiken mit der CLI anzeigen

Geben Sie in der Befehlszeile Folgendes ein:

stat apispec <apispec name>

Beispiel

stat apispec testapispec

API-Spezifikationen und API-Endpunktstatistiken mit der GUI anzeigen

  1. Navigieren Sie zu Sicherheit > NetScaler Web App Firewall > Importe.

  2. Wählen Sie auf der Seite Importe die Registerkarte API-Spezifikationsimport aus und klicken Sie dann auf Statistiken.

    Die Zusammenfassung der API-Spezifikationen wird angezeigt.

  3. Um die Endpunktzusammenfassung anzuzeigen, klicken Sie auf eine der API-Spezifikationen.

    Die Zusammenfassung der API-Endpunkte wird für die ausgewählte API-Spezifikation angezeigt.

API-Spezifikation importieren
June 13, 2024
Beitrag von: 
C
June 13, 2024
Beitrag von: 
C

In diesem Artikel

Feedback zur Site | Your privacy choices footer linkIhre Datenschutzauswahl | Datenschutz und rechtliche Bestimmungen | Cookie-Einstellungen | Einstellungen für die Zustimmung | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.