Parameter für einen Pfad definieren

Online bearbeiten

Pfadparameter können Variablenelemente eines URL-Pfads, Abfrageparameter, Header oder einen Anforderungshauptteil angeben. Die Parameter gelten für alle Operationen, die unter dem Pfad definiert sind. Ein Pfadparameter kann auf Operationsebene überschrieben, aber nicht dort entfernt werden.

Informationen zu dieser Task

Hinweis: Diese Task bezieht sich auf die Konfiguration einer OpenAPI 2.0 . Details zum Konfigurieren einer OpenAPI 3.0 -API-Definition finden Sie unter Bearbeiten einer OpenAPI 3.0 -API-Definition.

Sie können diese Task entweder mithilfe der UI-Anwendung API Designer oder mithilfe der browserbasierten Benutzerschnittstelle von API Manager ausführen.

Sie können jederzeit direkt zur zugrunde liegenden YAML-Quelle von „ OpenAPI “ wechseln, indem Symbol für OpenAPI -QuelleSie auf das Symbol „Quelle“ klicken. Um zum Entwurfsformular zurückzukehren, klicken Sie auf das Formular -Symbol Formularsymbol.

Vorgehensweise

  1. Öffnen Sie die API zur Bearbeitung, wie unter Bearbeiten einer OpenAPI 2.0 -API-Definitionbeschrieben.
  2. Erweitern Sie Pfade.
  3. Erweitern Sie den erforderlichen Pfad. Wenn bereits mindestens ein Parameter definiert ist, erweitern Sie Pfadparameter.
  4. Sie können entweder einen neuen Parameter erstellen oder einen vorhandenen Parameter bearbeiten.
    • Um einen Parameter zu erstellen, klicken Sie auf das Symbol OpenAPI 2.0 Symbol für Hinzufügen von APIs „Hinzufügen“ neben „Pfadparameter “ und lesen Sie dann den Abschnitt „Erstellen eines Parameters “.
    • Um einen vorhandenen Parameter zu bearbeiten, klicken Sie im Navigationsbereich auf den Parameternamen und lesen Sie dann den Abschnitt „Einen Parameter bearbeiten “.