Antworten definieren den HTTP-Statuscode und die Daten, die in einem Antworthauptteil und -header zurückgegeben werden. Sie können Antworten bearbeiten, die zuvor für Pfadoperationen in Ihrer API-Definition erstellt wurden.
Vorbereitende Schritte
Öffnen Sie das Detailformular für eine Antwort. Details zu den Bereichen in Ihrer API-Definition, in denen Sie eine Antwort bearbeiten können, finden Sie in den folgenden Abschnitten:
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.
Sie können jederzeit direkt zur zugrunde liegenden YAML-Quelle von „ OpenAPI “ wechseln, indem 
Sie auf das Symbol „Quelle“ klicken. Um zum Entwurfsformular zurückzukehren, klicken Sie auf das Formular -Symbol 
.
Vorgehensweise
- Geben Sie die folgenden Informationen an:
- Antwortname: Ein Name für die Antwort.
Wenn Sie eine Operationsantwort bearbeiten, ist dieser Name der HTTP-Statuscode.
Wenn Sie eine Antwortkomponente bearbeiten, definiert dieser Name einen Schlüssel, der es ermöglicht, dass diese Antwort von anderer Stelle in der API-Definition referenziert wird. Die Referenz hat folgendes Format:
#/components/responses/Name
Um den Namen zu ändern, klicken Sie auf Aktualisierenund anschließend auf Speichern .
- Beschreibung: Eine Beschreibung der Antwort Für die Darstellung von Rich Text können Sie die Syntax „ CommonMark “ verwenden.
- Headers: Header definieren Informationen, die in der Antwort zurückgegeben werden können.
Um einen neuen Header für die Antwort zu definieren, klicken Sie auf „Hinzufügen“ und lesen Sie anschließend den Abschnitt „Erstellen eines Headers “.
Um eine vorhandene Kopfzeile zu bearbeiten, klicken Sie auf den Namen der Kopfzeile und lesen Sie dann den Abschnitt „Bearbeiten einer Kopfzeile “.
- Inhalt: Eine Inhaltsdefinition beschreibt den Inhalt der Antwort.
Um eine neue Inhaltsdefinition für die Antwort zu erstellen, klicken Sie auf „Hinzufügen“ und lesen Sie anschließend den Abschnitt „Erstellen einer Inhaltsdefinition “.
Um eine vorhandene Inhaltsdefinition zu bearbeiten, klicken Sie auf den Namen der Inhaltsdefinition und lesen Sie dann den Abschnitt „Bearbeiten einer Inhaltsdefinition “.
- Links: Links beschreiben, wie verschiedene Werte, die von einer Operation zurückgegeben werden, als Eingabe für andere Operationen verwendet werden können.
Um einen neuen Link für die Antwort zu definieren, klicken Sie auf „Hinzufügen“ und lesen Sie anschließend den Abschnitt „Link erstellen “.
Um einen bestehenden Link zu bearbeiten, klicken Sie auf den Namen des Links und lesen Sie dann den Abschnitt „Einen Link bearbeiten “.
- Klicken Sie anschließend auf Speichern .
Nächste Schritte
Falls erforderlich, verwenden Sie den Navigationspfad, um zu einer anderen Position in der
Hierarchie des Objekts zu navigieren, an dem Sie arbeiten.