Operation in einer REST-API mit dem REST-API-Editor für Swagger 2-Dokumente implementieren

Mit dem REST-API-Editor in der Ansicht "Anwendungsentwicklung" können Sie Operationen in einer REST-API implementieren.

Vorbereitungen

Erstellen Sie eine REST-API auf der Grundlage eines Swagger-2.0 -Spezifikationsdokuments im „ IBM® App Connect Enterprise “-Toolkit, wie unter „Erstellen einer REST-API“ beschrieben.
Wenn Sie die REST-API von Grund auf neu erstellt haben, indem Sie Ressourcen, Modelle und Operationen definiert haben (wie im Abschnitt „Erstellen einer REST-API von Grund auf mit Swagger-Spezifikationen unter Verwendung des „ IBM App Connect Enterprise -Toolkits“ beschrieben), müssen Sie die Operationen auch im REST-API-Editor definieren. Weitere Informationen finden Sie unter Ressourcen, Modelle und Operationen in einer REST-API mit dem REST-API-Editor definieren.

Informationen zu dieser Task

Operationen in einer REST-API werden als untergeordnete Nachrichtenflüsse implementiert und Sie müssen mit dem REST-API-Editor für jede Operation einen leeren untergeordneten Nachrichtenfluss erstellen. Sie können den Vorgang dann umsetzen, indem Sie einen der Standard-Nachrichtenflussknoten von „ IBM App Connect Enterprise “ zum Teilablauf hinzufügen.

Wenn Sie keine Operation implementieren, können Sie die REST-API trotzdem in einem Integrationsserverimplementieren. Wenn jedoch ein HTTP -Kunde versucht, eine nicht implementierte Operation aufzurufen, wird eineHTTP 501 Not ImplementedStatuscode wird an den Client zurückgegeben.

Vorgehensweise

Führen Sie zum Implementieren einer Operation in einer REST-API die folgenden Schritte aus:

Öffnen Sie die REST-API, die die Operation enthält, die Sie implementieren möchten.
Der REST-API-Editor befindet sich in der Ansicht Anwendungsentwicklung unter dem REST-API-Projekt.
Suchen Sie die Operation im REST-API-Editor. Operationen werden unter der Überschrift "Operationen" aufgelistet und nach Ressource gruppiert.
Der Header-Abschnitt zeigt die Details für die REST-API-Basis URL.
Im Abschnitt Ressourcen werden die Operationen für die einzelnen Ressourcen angezeigt.
Klicken Sie auf diese Schaltfläche, um einen untergeordneten Nachrichtenfluss für die Operation zu erstellen: Wenn Sie bereits einen untergeordneten Nachrichtenfluss für die Operation definiert haben, wird dieser untergeordnete Nachrichtenfluss geöffnet. Nach dem Klicken auf diese Schaltfläche werden Sie aufgefordert, das Speichern der REST-API zu bestätigen. Durch das Speichern der REST-API wird sichergestellt, dass die Knoten, die Sie zum untergeordneten Nachrichtenfluss hinzufügen, mit der aktuellen Definition der REST-API ordnungsgemäß definiert sind. Der untergeordnete Nachrichtenfluss wird im Nachrichtenflusseditor im Vordergrund geöffnet.
Verwenden Sie die Kurzinfo, die für jede Schaltfläche bereitgestellt wird, um sich über die zugehörige Aktion zu informieren.
Führen Sie den Vorgang aus, indem Sie einen der Standard-Nachrichtenflussknoten „ IBM App Connect Enterprise “ zum Teilablauf hinzufügen.
Weitere Informationen finden Sie unter REST-API-Operation mithilfe einer Nachrichtenzuordnung implementieren.
Greifen Sie auf die Informationen zur REST-API-Operation, die REST-API-Operationsparameter und den REST-API-Anforderungs-und -Antworthauptteil zu, wie unter REST-API-Operationsverarbeitung im untergeordneten Nachrichtenfluss mit Nachrichtenflussknoten implementierenbeschrieben.

Ergebnisse

Die Operation wird in der REST-API implementiert.

Nächste Schritte

Sie müssen Ihre REST-API in einem Integrationsserverpacken und implementieren, wie im Abschnitt REST-API packen und implementierenbeschrieben.

Sie können auch die folgenden zusätzlichen Aufgaben ausführen:

Implementieren Sie eine Fehlerbehandlung für die REST-API in Form von untergeordneten Nachrichtenflüssen. Weitere Informationen finden Sie unter Fehlerbehandlungsroutine in einer REST-API implementieren.
Sichern Sie Ihre REST-API mit HTTPS, damit die Kommunikation zwischen Client und Server verschlüsselt werden. Weitere Informationen finden Sie unter "Sichern einer REST-API mithilfe von HTTPS ".
Sichern Sie Ihre REST-API durch die Authentifizierung von Benutzern mit der HTTP-Basisauthentifizierung. Weitere Informationen finden Sie unter "Sichern einer REST-API mithilfe der HTTP -Standardauthentifizierung ".
Wenn Ihre REST-API von clientseitigem Code verwendet werden soll, der in einem Web-Browser ausgeführt wird, müssen Sie möglicherweise Cross-Origin Resource Sharingkonfigurieren, wie im Abschnitt Web-Browsern den Zugriff auf eine REST-API über Cross-Origin Resource Sharing ermöglichenbeschrieben.
Sie können die JSON-Validierung für Ihre REST-API aktivieren, indem Sie die Einstellungen für die Nachrichtenprüfung im REST-API-Editor von ACE verwenden. Weitere Informationen zur JSON-Validierung finden Sie unter JSON-Validierung.
Die REST-APIs sind standardmäßig für die Verarbeitung von JSON-Daten konfiguriert. Informationen zur Handhabung von Nicht-JSON-Daten finden Sie unter Handhabung von Nicht-JSON-Daten in einer REST-API.