Vorgehensweise zum Verwenden einer REST API für die Integration von Automation Pipelines in andere Anwendungen

Automation Pipelines bietet ein REST-Plug-In, mit dem Sie Automation Pipelines in andere Anwendungen integrieren können, die eine REST API verwenden, sodass Sie Softwareanwendungen, die miteinander interagieren müssen, kontinuierlich entwickeln und bereitstellen können. Das REST-Plug-In ruft eine API auf, die Informationen zwischen Automation Pipelines und einer anderen Anwendung sendet und empfängt.

Mit dem REST-Plug-In können Sie:

Externe REST API-basierte Systeme in eine Automation Pipelines-Pipeline integrieren.
Eine Automation Pipelines-Pipeline als Teil des Ablaufs von externen Systemen integrieren.

Das REST-Plug-In funktioniert mit jeder REST API und unterstützt GET-, POST-, PUT-, PATCH- und DELETE-Methoden zum Senden oder empfangen von Informationen zwischen Automation Pipelines und anderen Anwendungen.

Tabelle 1. Vorbereiten einer Pipeline für die Kommunikation über die REST API
Aktion	Ergebnis
Fügen Sie der Pipeline eine REST-Aufgabe hinzu.	Die REST-Aufgabe kommuniziert Informationen zwischen Anwendungen und kann Statusinformationen für eine nachfolgende Aufgabe in der Pipeline bereitstellen.
Wählen Sie die REST-Aktion aus und schließen Sie dabei die URL ein.	Die Pipeline-Aufgabe ruft die URL auf, wenn die Pipeline ausgeführt wird. Für POST-, PUT- und PATCH-Aktionen müssen Sie eine Nutzlast hinzufügen. In der Nutzlast können Sie Ihre Pipeline- und Aufgabeneigenschaften binden, wenn die Pipeline ausgeführt wird.
Beachten Sie dieses Beispiel.	Beispiel für die Verwendung des REST-Plug-Ins: Sie können eine REST-Aufgabe hinzufügen, um Informationen abzurufen, die für eine nachfolgende Pipeline-Aufgabe benötigt werden.

Ähnlich wie bei Verwendung des REST-Plug-Ins zum Aufrufen einer API können Sie eine Abfrageaufgabe in Ihre Pipeline einfügen, um eine REST API aufzurufen und sie abzufragen, bis diese abgeschlossen ist und die Pipeline Aufgabe die Beendigungskriterien erfüllt. Weitere Informationen hierzu finden Sie unter In Automation Pipelines verfügbare Aufgabentypen.

Sie können auch REST APIs zum Importieren und Exportieren einer Pipeline verwenden und die Beispielskripts zum Ausführen einer Pipeline verwenden.

In diesem Verfahren ruft die REST-Aufgabe ein Build-Tag von einem Dienst ab, und eine nachfolgende CI-Aufgabe verwendet das Build-Tag, um eine CICD-Build-Nummer abzurufen.

Prozedur

Um eine Pipeline zu erstellen, klicken Sie auf Pipelines > Neue Pipeline > Leere Arbeitsfläche.
Klicken Sie in Ihrer Pipeline-Phase auf + Sequenzielle Aufgabe.

Fügen Sie im Aufgabenbereich die REST-Aufgabe hinzu:

Geben Sie einen Namen für die Aufgabe ein.
Wählen Sie im Dropdown-Menü „Typ“ die Option REST aus.
Wählen Sie im Bereich „REST-Anforderung“ die Option GET aus.
Damit die REST-Aufgabe Daten von einer anderen Anwendung anfordern kann, wählen Sie die GET-Methode aus. Um Daten an eine andere Anwendung zu senden, wählen Sie die POST-Methode aus.
Geben Sie die URL ein, die den REST API-Endpoint identifiziert, der zum Abrufen des Build-Tags verwendet wird. Beispiel:
```
https://devops.mycompany.com:8001/job/service-build/api/json
```
Hinweis: Automation Pipelines bietet keine Unterstützung für %2F als URL-Codierung für / wie in:
```
https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME%2Ftest.yaml
```
Verwenden Sie bei der Angabe des REST API-Endpoints ein URL-Basisformat, wie z. B.:
```
https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME/test.yaml
```
Damit eine REST-Aufgabe Daten aus einer anderen Anwendung importieren kann, können Sie die Nutzlastvariable einbeziehen. Bei einer Importaktion können Sie beispielsweise ${Stage0.export.responseBody} eingeben. Wenn die Größe der Antwortdaten 5 MB überschreitet, schlägt die REST-Aufgabe möglicherweise fehl.

Um die Autorisierung für die Aufgabe bereitzustellen, klicken Sie auf Header hinzufügen. Geben Sie dann Headerschlüssel und Werte ein, wie z. B.:


Key	Wert
Akzeptieren	application/json
Inhaltstyp	application/json

Wenn Sie eine REST-Aufgabe hinzufügen und die REST-Anforderung konfigurieren, wählen Sie die Aktion aus, geben Sie die URL ein und fügen Sie alle Header für die Autorisierung hinzu.

Fügen Sie die nachfolgende Aufgabe hinzu, die Informationen aus der REST-Aufgabenantwort verwendet.
Um Ihre Pipeline zu speichern, klicken Sie auf Speichern.
Klicken Sie auf der Registerkarte „Pipeline“ auf Pipeline aktivieren.
Klicken Sie auf Speichern und dann auf Schließen.
Klicken Sie auf Ausführen.
Um die Pipeline-Ausführung zu überwachen, klicken Sie auf Ausführungen.
Um zu überprüfen, ob die REST-Aufgabe die erwarteten Informationen zurückgibt, untersuchen Sie die Pipeline-Ausführung und die Aufgabenergebnisse.
1. Nachdem die Pipeline abgeschlossen ist, klicken Sie auf den Link zur Ausführung der Pipeline, um zu bestätigen, dass die andere Anwendung die von Ihnen angeforderten Daten zurückgegeben hat.
2. Klicken Sie auf die REST-Aufgabe in der Pipeline.
3. Klicken Sie in der Pipeline-Ausführung auf die Aufgabe, sehen Sie sich die Aufgabendetails an und überprüfen Sie, ob die REST-Aufgabe die erwarteten Ergebnisse zurückgegeben hat.
  Die Aufgabendetails zeigen den Antwortcode, den Textkörper, die Headerschlüssel und die Werte an.
Um die JSON-Ausgabe anzuzeigen, klicken Sie auf JSON-AUSGABE ANZEIGEN.

Ergebnisse

Herzlichen Glückwunsch! Sie haben eine REST-Aufgabe konfiguriert, die eine REST API aufgerufen und Informationen zwischen Automation Pipelines und einer anderen Anwendung über das REST-Plug-In gesendet hat.

Nächste Maßnahme

Verwenden Sie weiterhin REST-Aufgaben in Ihren Pipelines, um Befehle auszuführen und Automation Pipelines in anderen Anwendungen zu integrieren, sodass Sie Ihre Softwareanwendungen entwickeln und bereitstellen können. Sie sollten Abfrageaufgaben verwenden, die die API abfragen, bis Sie abgeschlossen ist und die Pipeline-Aufgabe die Beendigungskriterien erfüllt.