Parameter für eine Operation definieren

Antworten definieren den HTTP-Statuscode und die Daten, die in einem Antworthauptteil und -header zurückgegeben 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 Pfadeund erweitern Sie anschließend den erforderlichen Pfad.
  3. Erweitern Sie Operationenund erweitern Sie dann die erforderliche Operation.
  4. Sie können entweder einen neuen Operationsparameter erstellen oder einen vorhandenen Parameter bearbeiten.
    • Um einen Operationsparameter 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 Betriebsparameter zu bearbeiten, klicken Sie im Navigationsbereich auf den Parameternamen und lesen Sie dann den Abschnitt „Bearbeiten eines Parameters “.