Automation Pipelines biedt een REST-invoegtoepassing waarmee u Automation Pipelines kunt integreren met andere applicaties die gebruikmaken van een REST API, zodat u voortdurend softwareapplicaties kunt ontwikkelen en leveren die met elkaar moeten communiceren. De REST-invoegtoepassing roept een API aan, die informatie verzendt en ontvangt tussen Automation Pipelines en een andere applicatie.

Met de REST-invoegtoepassing kunt u volgende doen:

  • Externe REST API-gebaseerde systemen in een Automation Pipelines-pijplijn integreren.
  • Een Automation Pipelines-pijplijn als onderdeel van de stroom van externe systemen integreren.

De REST-invoegtoepassing werkt met elke REST API en ondersteunt GET-, POST-, PUT-, PATCH- en DELETE-methoden om informatie te verzenden of te ontvangen tussen Automation Pipelines en andere applicaties.

Tabel 1. Een pijplijn voorbereiden om te communiceren via de REST API
Wat u doet Wat gebeurt er als gevolg
Voeg een REST-taak toe aan uw pijplijn.

De REST-taak communiceert informatie tussen applicaties en kan statusinformatie geven voor een opeenvolgende taak in de pijplijnfase.

Selecteer in de REST-taak de REST-actie en neem de URL op.

De pijplijntaak roept de URL op wanneer de pijplijn wordt uitgevoerd.

Voor POST-, PUT- en PATCH-acties moet u een lading toevoegen. In de lading kunt u de pijplijn en taakproperties binden wanneer de pijplijn wordt uitgevoerd.

Overweeg dit voorbeeld.

Voorbeeld van het gebruik van de REST-invoegtoepassing:

U kunt een REST-taak toevoegen om informatie op te halen die nodig is voor een volgende pijplijntaak.

Net als bij het gebruik van de REST-invoegtoepassing om een API aan te roepen, kunt u een polltaak in uw pijplijn opnemen om een REST API aan te roepen en deze te pollen totdat deze is voltooid en de pijplijntaak voldoet aan de afsluitcriteria. Zie Welke typen taken zijn beschikbaar in Automation Pipelines.

U kunt ook REST API's gebruiken om een pijplijn te importeren en exporteren en de voorbeeldscripts gebruiken om een pijplijn uit te voeren.

In deze procedure krijgt de REST-taak een buildtag van één service en gebruikt een volgende CI-taak de buildtag om een CICD-buildnummer te verkrijgen.

Procedure

  1. Als u een pijplijn wilt maken, klikt u op Pijplijnen > Nieuwe pijplijn > Blanco canvas.
  2. Klik in uw pijplijnfase op + Sequentiële taak.
  3. Voeg in het taakdeelvenster de REST-taak toe:
    1. Voer een naam in voor de taak.
    2. Selecteer REST in het vervolgkeuzemenu Type.
    3. Selecteer GET in het REST-aanvraaggebied.
      Als u wilt dat de REST-taak gegevens uit een andere applicatie opvraagt, selecteert u de GET-methode. Als u gegevens naar een andere applicatie wilt verzenden, selecteert u de POST-methode.
    4. Voer de URL in die het REST API-eindpunt identificeert dat wordt gebruikt om de buildtag te verkrijgen. Bijvoorbeeld: 
      https://devops.mycompany.com:8001/job/service-build/api/json
      Opmerking: Automation Pipelines biedt geen ondersteuning voor %2F als URL-codering voor / zoals in: 
      https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME%2Ftest.yaml
      Wanneer u het REST API-eindpunt opgeeft, gebruikt u een basis-URL-indeling zoals: 
      https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME/test.yaml
      Voor een REST-taak om gegevens uit een andere applicatie te importeren, kunt u de ladingsvariabele opnemen. Voor een importactie kunt u bijvoorbeeld ${Stage0.export.responseBody} invoeren. Als de responsgegevens groter dan 5 MB zijn, kan de REST-taak mislukken.
    5. Als u autorisatie voor de taak wilt opgeven, klikt u op Kopteksten toevoegen en voert u koptekstsleutels en -waarden in, zoals:
      Key Waarde
      Accepteren application/json
      Content-Type application/json
    Wanneer u een REST-taak toevoegt en de REST-aanvraag configureert, selecteert u de actie, voert u de URL in en voegt u kopteksten voor verificatie toe.
  4. Voeg de volgende taak toe die gebruikmaakt van informatie uit het antwoord van de REST-taak.
  5. Klik op Opslaan om uw pijplijn op te slaan.
  6. Klik op het tabblad Pijplijn op Pijplijn inschakelen.
    Voordat de pijplijn kan worden uitgevoerd, moet u deze inschakelen.
  7. Klik op Opslaan en klik vervolgens op Sluiten.
  8. Klik op Uitvoeren.
  9. Klik op Uitvoeren om de uitvoering van de pijplijn te bekijken.
    Nadat is begonnen met het uitvoeren van de pijplijn, kunt u de pijplijnstatus bekijken terwijl deze wordt uitgevoerd.
  10. Om te controleren of de REST-taak de verwachte informatie retourneert, bekijkt u de pijplijnuitvoering en de taakresultaten.
    1. Nadat de pijplijn is voltooid, kunt u bevestigen dat de andere applicatie de door u aangevraagde gegevens heeft geretourneerd door op de link naar de pijplijn-uitvoering te klikken.
    2. Klik op de REST-taak in de pijplijn.
    3. In de pijplijnuitvoering klikt u op de taak, bekijkt u de taakgegevens en controleert u of de REST-taak de verwachte resultaten heeft geretourneerd.
      In de taakgegevens worden de responscode, de tekst, de koptekstsleutels en de waarden weergegeven.
      De details voor de REST-taak bevatten de status VOLTOOID, de antwoordcode, de antwoordtekst en koptekstsleutels en -waarden.
  11. Als u de JSON-output wilt zien, klikt u op JSON-OUTPUT WEERGEVEN.
    De JSON-uitvoer voor de REST-taak geeft de antwoordkopteksten en antwoordtekst weer en bevat de padzoeker om de inhoud te doorzoeken.

resultaten

Gefeliciteerd! U heeft een REST-taak geconfigureerd die een REST API heeft aangeroepen en informatie heeft verzonden tussen Automation Pipelines en een andere applicatie met behulp van de REST-invoegtoepassing.

Volgende stappen

Blijf REST-taken in uw pijplijnen gebruiken om opdrachten uit te voeren en Automation Pipelines te integreren met andere applicaties, zodat u uw softwareapplicaties kunt ontwikkelen en leveren. Overweeg het gebruik van pollingtaken om de API te pollen totdat deze is voltooid en de pijplijntaak voldoet aan de afsluitcriteria.