Ein Pfad ist eine Einheit einer REST-API, die Sie aufrufen können. Ein Pfad besteht aus einem HTTP-Verb und einem URL-Pfad. Durch Konfigurieren des Pfads können Sie definieren, wie die API für Ihre Entwickler
verfügbar gemacht wird.
Informationen zu dieser Task
Hinweis:
- Diese Task bezieht sich auf die Konfiguration einer OpenAPI 3.0-API-Definition. Details zum Konfigurieren einer OpenAPI 2.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 2.0 -API-Definition.
- OpenAPI 3.0 -APIs werden nur mit dem DataPower® API Gatewayunterstützt, nicht mit dem DataPower Gateway (v5 compatible).
- Details zu aktuellen OpenAPI 3.0 -Unterstützungseinschränkungen finden Sie unter OpenAPI 3.0 -Unterstützung in IBM®
API Connect.
Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.
Der Pfad wird an die Server-URL angehängt, um die vollständige URL zu bilden. Details zur Konfiguration von Servern finden Sie unter Server für eine API definieren.
Sie können jederzeit direkt zur zugrunde liegenden OpenAPI -YAML-Quelle wechseln, indem Sie auf das Symbol Quelle 
klicken. Klicken Sie auf das Symbol Formular 
, um zum Designformular zurückzukehren.
Vorgehensweise
- Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 3.0 -API-Definitionbeschrieben.
- Wenn bereits ein oder mehrere Pfade definiert sind, erweitern Sie Pfade.
- Klicken Sie zum Erstellen eines neuen Pfads auf das Symbol 'Hinzufügen'
neben Pfade im Navigationsfenster. Um einen vorhandenen Pfad zu bearbeiten, klicken Sie im Navigationsfenster darauf.
- Geben Sie die folgenden Informationen an:
- Pfad: Ein relativer Pfad zu einem einzelnen Endpunkt.
Der Pfad wird zur Erstellung des vollständigen URI für den Zugriff auf die APIs an den Basispfad angehängt. Der Pfad muss mit dem Zeichen/beginnen, aber nicht enden. Ein Parameter am Ende des Pfads kann ein Qualifikationsmerkmal für eine oder mehrere Pfadebenen enthalten.
Wenn Sie nur den Namen des Parameters angeben, wird eine Ebene dieses Pfads abgeglichen. Wenn Sie mehrere Ebenen des Pfads zulassen möchten, kann dem Parameter eines der folgenden Qualifikationsmerkmale vorangestellt werden:
- *, um 0 oder mehr Vorkommen anzugeben
- + zur Angabe von 1 oder mehr Vorkommen
Die Qualifikationsmerkmale + und * können nur am Ende des Pfads verwendet werden.
Beispiel für den Pfad:
/petstore/{type}/{*category}
entspricht den folgenden Pfaden, bei denen nur ein Typwert übereinstimmt, aber alle (0 oder mehr) Kategorien übereinstimmen:
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
- Ref (verfügbar, wenn Sie einen vorhandenen Pfad bearbeiten): Ein Verweis auf einen Pfad, der an anderer Stelle definiert ist, entweder in dieser OpenAPI-Definition oder in einer externen Datei. Eine Referenz ermöglicht die Wiederverwendung einer Reihe von Operationen, die bereits für einen Pfad in dieser API definiert wurden, oder in einer Datei, die entweder eine vollständige API-Definition oder ein OpenAPI-Fragment ist.
Die Referenz verwendet JSON-Zeiger-Notation. Beispiel: Ein Verweis auf einen Pfad mit dem Namen
/mypath in dieser API hätte folgendes Format:
#/paths/~1mypath
Das Zeichen
~1 wird verwendet, um den
/ auszukommentieren, das als Teil des Pfadnamens und nicht als Sonderzeichen verwendet wird.
Ein Verweis auf einen Pfad in einer externen Datei mit dem Namen
path_fragments.yaml hätte folgendes Format:
file://path_fragments.yaml/paths/~1mypath
- Zusammenfassung: Eine optionale Zusammenfassung, die für alle Operationen in diesem Pfad gelten soll.
- Beschreibung: Eine optionale Beschreibung, die für alle Operationen in diesem Pfad gelten soll. Sie können die CommonMark -Syntax für die Rich-Text-Darstellung verwenden.
- Wenn Sie einen neuen Pfad erstellen, klicken Sie auf Erstellen.
Die Pfaddetails werden zur weiteren Bearbeitung angezeigt, wie in Schritt
4beschrieben.
- Klicken Sie anschließend auf Speichern .