vRealize Automation Code Stream biedt een REST-invoegtoepassing waarmee u vRealize Automation Code Stream 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 vRealize Automation Code Stream en een andere applicatie.

Met de REST-invoegtoepassing kunt u volgende doen:

  • Externe REST API-gebaseerde systemen in een vRealize Automation Code Stream-pijplijn integreren.
  • Een vRealize Automation Code Stream-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 vRealize Automation Code Stream en andere applicaties.

Tabel 1. Een pijplijn voorbereiden om te communiceren via de REST API
Wat u doet… Wat er gebeurt…
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 een tag te maken op een Git-commit voor een build en de taak een aanvraag te laten indienen om de incheck-ID uit de opslagplaats te halen. De taak kan een lading naar uw opslagplaats sturen en een tag voor de build maken en de opslagplaats kan het antwoord met de tag retourneren.

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.

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

Deze procedure haalt een eenvoudige URL op.

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 voor de identificatie van het REST API-eindpunt. Bijvoorbeeld: https://www.google.com.
      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 toevoegenen voert u een koptekstsleutel en -waarde in.
    Een REST-taak in een pijplijn toevoegen en configureren.
  4. Klik op Opslaan om uw pijplijn op te slaan.
  5. Klik op het tabblad Pijplijn op Pijplijn inschakelen.
    Een pijplijn inschakelen die een REST-taak bevat.
  6. Klik op Opslaan en klik vervolgens op Sluiten.
  7. Klik op Uitvoeren.
  8. Klik op Uitvoeren om de uitvoering van de pijplijn te bekijken.
    De uitvoering bekijken van een pijplijn die een REST-taak bevat.
  9. Om te controleren of de REST-invoegtoepassing de verwachte informatie retourneert, bekijkt u de pijplijn-uitvoering 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 pijplijn-uitvoering klikt u op de taak, kijkt u naar de taakgegevens en controleert u of de REST-invoegtoepassing de verwachte resultaten heeft geretourneerd.
      In de taakgegevens worden de responscode, de tekst, de koptekstsleutels en de waarden weergegeven.
      Taakgegevens voor een pijplijn die een REST-taak bevat.
  10. Als u de JSON-output wilt zien, klikt u op JSON-OUTPUT WEERGEVEN.
    De JSON-output van een REST-taak in een pijplijn bekijken.

resultaten

Gefeliciteerd! U heeft een REST-taak geconfigureerd die een REST API heeft aangeroepen en informatie heeft verzonden tussen vRealize Automation Code Stream 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 vRealize Automation Code Stream 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.