REST-API aus einem importierten Swagger-Dokument erstellen

Um eine REST-API in „ IBM® App Connect Enterprise “ zu erstellen, können Sie mithilfe des „ IBM App Connect Enterprise “-Toolkits ein Swagger -Dokument importieren.

Vorbereitungen

Erstellen Sie ein Swagger -Dokument, das die Ressourcen und Operationen beschreibt, die Sie in der REST-API verwenden wollen. Stellen Sie sicher, dass das Swagger -Dokument den Richtlinien der Swagger-Spezifikation entspricht und die Anforderungen von IBM App Connect Enterprise erfüllt. Weitere Informationen finden Sie unter „Swagger RESTful API Documentation Specification Version 2.0 “ und unter „Einschränkungen bei Swagger-Dokumenten “.

Informationen zu dieser Task

Um eine REST-API in „ IBM App Connect Enterprise “ zu erstellen, können Sie den Assistenten „Create a REST API“ im „ IBM App Connect Enterprise -Toolkit “ verwenden, um ein Swagger -Dokument zu importieren. Erstellen Sie anschließend die REST-API und andere Projektartefakte, die zum Implementieren und Bereitstellen der neuen REST-API erforderlich sind. Alternativ können Sie eine REST-API erstellen, indem Sie die Modelle, Ressourcen und Operationen von Grund auf neu definieren, wie unter „Erstellen einer REST-API von Grund auf mit Swagger-Spezifikationen unter Verwendung des IBM App Connect Enterprise -Toolkits“ beschrieben.

Vorgehensweise

Gehen Sie wie folgt vor, um eine REST-API durch Importieren eines Swagger -Dokuments zu erstellen:

  1. Öffnen Sie den Assistenten REST-API erstellen , indem Sie auf Datei > Neu > REST-API klicken.
  2. Geben Sie einen Namen für die REST-API ein.
    Der von Ihnen angegebene Name wird als Name des Projekts im „ IBM App Connect Enterprise “-Toolkit verwendet.
  3. Wählen Sie In einem Swagger-Dokument definierte Ressourcen und Operationen importieren aus und klicken Sie anschließend auf Next.
  4. Wählen Sie den Pfad zum Swagger -Dokument aus, das die Ressourcen und Operationen beschreibt, die Sie in der REST-API verwenden möchten.
    Sie können das Swagger -Dokument aus dem Dateisystem oder aus einem vorhandenen Projekt im Arbeitsbereich importieren.
    Die Datei wird für die Verwendung in einer REST-API validiert. Wenn Fehler gefunden werden, während das ausgewählte Swagger -Dokument validiert wird, werden diese Gültigkeitsfehler im Assistent angezeigt. Wenn Gültigkeitsfehler im ausgewählten Swagger -Dokument gefunden werden, können Sie nicht fortfahren.
  5. Optional: Klicken Sie auf Weiter, um die Liste der Ressourcen und Operationen zu überprüfen, die im ausgewählten Swagger -Dokument enthalten sind.
  6. Klicken Sie auf Fertigstellen, um die Erstellung der REST-API abzuschließen.
    Die REST-API-Beschreibung für die neue REST-API wird automatisch geöffnet, die Sie verwenden können, um Operationen wie unter Operation in einer REST-API mit dem REST-API-Editor für Swagger 2-Dokumente implementierenbeschrieben zu implementieren.

Ergebnisse

Die REST-API wurde erstellt.

Nächste Schritte

Implementieren Sie jede Operation in der REST-API als untergeordneten Nachrichtenfluss. Weitere Informationen finden Sie unter Operation in einer REST-API mit dem REST-API-Editor für Swagger 2-Dokumente implementieren.