vRealize Automation Code Stream fornisce un plug-in REST, che consente di integrare vRealize Automation Code Stream con altre applicazioni che utilizzano una REST API, per consentire lo sviluppo e la distribuzione continuativi di applicazioni software che devono interagire tra loro. Il plug-in REST richiama un'API, che invia e riceve informazioni tra vRealize Automation Code Stream e un'altra applicazione.

Con il plug-in REST, è possibile:

  • Integrare in una pipeline di vRealize Automation Code Streamsistemi esterni basati sulla REST API.
  • Integrare una pipeline di vRealize Automation Code Stream come parte del flusso di sistemi esterni.

Il plug-in REST funziona con qualsiasi REST API e supporta i metodi GET, POST, PUT, PATCH e DELETE per inviare o ricevere informazioni tra vRealize Automation Code Stream e altre applicazioni.

Tabella 1. Preparazione di una pipeline per la comunicazione tramite la REST API
Cosa fare Cosa accade di conseguenza
Aggiungere un'attività REST alla pipeline.

L'attività REST comunica le informazioni tra le applicazioni e può fornire informazioni sullo stato per un'attività successiva nella fase della pipeline.

Nell'attività REST selezionare l'azione REST e includere l'URL.

L'attività della pipeline richiama l'URL quando la pipeline viene eseguita.

Per le azioni POST, PUT e PATCH, è necessario includere un payload. Nel payload è possibile associare le proprietà di pipeline e attività quando la pipeline viene eseguita.

Si consideri questo esempio.

Esempio di utilizzo del plug-in REST:

È possibile aggiungere un'attività REST per creare un tag su un commit Git per una build e fare in modo che l'attività invii una richiesta per ottenere l'ID di archiviazione dal repository. L'attività può inviare un payload al repository e creare un tag per la build e il repository può restituire la risposta con il tag.

In modo analogo all'utilizzo del plug-in REST per richiamare un'API, è possibile includere un'attività di polling nella pipeline per richiamare una REST API ed eseguirne il polling finché non viene completata e finché l'attività della pipeline non soddisfa i criteri di uscita.

È inoltre possibile utilizzare le REST API per importare ed esportare una pipeline, nonché utilizzare gli script di esempio per eseguire una pipeline.

Questa procedura consente di ottenere un URL semplice.

Procedura

  1. Per creare una pipeline, fare clic su Pipeline > Nuova pipeline > Tela vuota.
  2. Nella fase della pipeline fare clic su + Attività sequenziale.
  3. Nel riquadro delle attività aggiungere l'attività REST:
    1. Immettere un nome per l'attività.
    2. Nel menu a discesa Tipo selezionare REST.
    3. Nell'area della richiesta REST selezionare GET.
      Per fare in modo che l'attività REST richieda dati di un'altra applicazione, selezionare il metodo GET. Per inviare dati a un'altra applicazione, selezionare il metodo POST.
    4. Immettere l'URL che identifica l'endpoint della REST API. Ad esempio https://www.google.com.
      Per consentire a un'attività REST di importare dati da un'altra applicazione, è possibile includere la variabile payload. Ad esempio, per un'azione di importazione, è possibile immettere ${Stage0.export.responseBody}. Se le dimensioni dei dati della risposta superano i 5 MB, l'attività REST potrebbe non riuscire.
    5. Per fornire l'autorizzazione per l'attività, fare clic su Aggiungi intestazioni e immettere una chiave di intestazione e un valore.
    Quando si aggiunge un'attività REST e si configura la richiesta REST, è possibile selezionare l'azione, immettere l'URL e aggiungere eventuali intestazioni per l'autorizzazione.
  4. Per salvare la pipeline, fare clic su Salva.
  5. Nella scheda Pipeline fare clic su Attiva pipeline.
    Per poter eseguire la pipeline, è necessario abilitarla.
  6. Fare clic su Salva, quindi su Chiudi.
  7. Fare clic su Esegui.
  8. Per osservare l'esecuzione della pipeline, fare clic su Esecuzioni.
    Dopo che la pipeline inizia a essere eseguita, è possibile osservare lo stato della pipeline durante l'esecuzione.
  9. Per verificare che l'attività REST restituisca le informazioni previste, esaminare l'esecuzione della pipeline e i risultati dell'attività.
    1. Al termine della pipeline, per verificare che l'altra applicazione abbia restituito i dati richiesti, fare clic sul collegamento all'esecuzione della pipeline.
    2. Fare clic sull'attività REST nella pipeline.
    3. Nell'esecuzione della pipeline fare clic sull'attività, osservare i dettagli e verificare che l'attività REST restituisca i risultati previsti.
      I dettagli dell'attività mostrano il codice di risposta, il corpo, le chiavi di intestazione e i valori.
      Il dettagli dell'attività REST mostrano lo stato come COMPLETATA, il codice di risposta, il corpo della risposta, nonché le chiavi e i valori di intestazione.
  10. Per visualizzare l'output JSON, fare clic su VISUALIZZA OUTPUT JSON.
    L'output JSON per l'attività REST mostra le intestazioni delle risposte e il corpo della risposta e include l'opzione Trova percorso per la ricerca dei contenuti.

risultati

Congratulazioni! È stata configurata un'attività REST che ha richiamato una REST API e ha inviato informazioni tra vRealize Automation Code Stream e un'altra applicazione utilizzando il plug-in REST.

Operazioni successive

Continuare a utilizzare le attività REST nelle pipeline per eseguire comandi e integrare vRealize Automation Code Stream con altre applicazioni per poter sviluppare e consegnare le applicazioni software. È consigliabile utilizzare le attività di polling che eseguono il polling dell'API fino al completamento e fino a quando l'attività della pipeline non soddisfa i criteri di uscita.