O Automation Pipelines fornece um plug-in REST, que permite integrar o Automation Pipelines com outros aplicativos que usam uma REST API para que você possa desenvolver e entregar continuamente aplicativos de software que devem interagir entre si. O plug-in REST invoca uma API, que envia e recebe informações entre o Automation Pipelines e outro aplicativo.

Com o plug-in REST, é possível:

  • Integrar sistemas externos com base em REST API em um pipeline do Automation Pipelines.
  • Integrar um pipeline do Automation Pipelines como parte do fluxo de sistemas externos.

O plug-in REST funciona com qualquer REST API e oferece suporte aos métodos GET, POST, PUT, PATCH e DELETE para enviar ou receber informações entre o Automation Pipelines e outros aplicativos.

Tabela 1. Como preparar um pipeline para se comunicar pela REST API
O que você faz O que acontece como resultado
Adicione uma tarefa REST ao pipeline.

A tarefa REST comunica informações entre aplicativos e pode fornecer informações de status para uma tarefa sucessiva no estágio do pipeline.

Na tarefa REST, selecione a ação REST e inclua o URL.

A tarefa de pipeline chama o URL quando o pipeline é executado.

Para ações de POST, PUT e PATCH, você deve incluir um payload. No payload, é possível associar as propriedades de pipeline e de tarefa quando o pipeline é executado.

Considere este exemplo.

Exemplo de uso do plug-in REST:

Você pode adicionar uma tarefa REST para obter informações necessárias para uma tarefa de pipeline subsequente.

Semelhante a usar o plug-in REST para invocar uma API, é possível incluir uma tarefa de Sondagem no pipeline para invocar uma REST API e sondá-la até que seja concluída e a tarefa do pipeline atenda aos critérios de saída. Consulte Que tipos de tarefas estão disponíveis no Automation Pipelines.

Também é possível usar as REST APIs para importar e exportar um pipeline, e usar os scripts de exemplo para executar um pipeline.

Neste procedimento, a tarefa REST obtém uma tag de compilação de um serviço, e uma tarefa de CI subsequente usa a tag de compilação para obter um número de compilação CICD.

Procedimento

  1. Para criar um pipeline, clique em Pipelines > Novo Pipeline > Tela em Branco.
  2. No estágio do pipeline, clique em + Tarefa Sequencial.
  3. No painel de tarefas, adicione a tarefa REST:
    1. Digite um nome para a tarefa.
    2. No menu suspenso Tipo, selecione REST.
    3. Na área de Solicitação REST, selecione GET.
      Para que a tarefa REST solicite dados de outro aplicativo, selecione o método GET. Para enviar dados para outro aplicativo, selecione o método POST.
    4. Digitar a URL que identifica o endpoint de REST API usado para obter a marca de compilação. Por exemplo: 
      https://devops.mycompany.com:8001/job/service-build/api/json
      Observação: O Automation Pipelines não oferece suporte a %2F como codificação de URL para / como em: 
      https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME%2Ftest.yaml
      Ao especificar o endpoint REST API, use um formato de URL básico, como: 
      https://gitlab.com/api/v4/projects/1234567/repository/files/FOLDERNAME/test.yaml
      Para que uma tarefa REST importe dados de outro aplicativo, é possível incluir a variável de payload. Por exemplo, para uma ação de importação, é possível digitar ${Stage0.export.responseBody}. Se o tamanho dos dados da resposta exceder 5 MB, a tarefa REST poderá falhar.
    5. Para fornecer autorização para tarefa, clique em Adicionar Cabeçalhos e digite chaves e valores de cabeçalho, como:
      Chave Valor
      Aceitar application/json
      Content-Type application/json
    Ao adicionar uma tarefa REST e configurar a solicitação REST, você seleciona a ação, insere a URL e adiciona quaisquer cabeçalhos para autorização.
  4. Adicione uma tarefa subsequente que use informações da resposta da tarefa REST.
  5. Para salvar o pipeline, clique em Salvar.
  6. Na guia pipeline, clique em Ativar pipeline.
    Antes que o pipeline possa ser executado, você deve ativá-lo.
  7. Clique em Salvar, depois clique em Fechar.
  8. Clique em Executar.
  9. Para observar a execução do pipeline, clique em Execuções.
    Depois que o pipeline começa a ser executado, você pode observar seu status enquanto ele é executado.
  10. Para verificar se a tarefa REST retorna as informações esperadas, examine a execução do pipeline e os resultados da tarefa.
    1. Após a conclusão do pipeline, para confirmar que o outro aplicativo retornou os dados solicitados, clique no link para a execução do pipeline.
    2. Clique na tarefa REST no pipeline.
    3. Na execução do pipeline, clique na tarefa, observe os detalhes da tarefa e verifique se a tarefa REST retornou os resultados esperados.
      Os detalhes da tarefa exibem o código de resposta, o corpo, as chaves de cabeçalho e os valores.
      Os detalhes da tarefa REST exibem o status como COMPLETED, o código da resposta, o corpo da resposta e as chaves e os valores do cabeçalho.
  11. Para exibir a saída JSON, clique em EXIBIR JSON DE SAÍDA.
    A saída JSON da tarefa REST exibe os cabeçalhos de resposta e o corpo da resposta e inclui o localizador de caminho para pesquisar o conteúdo.

Resultados

Parabéns! Você configurou uma tarefa REST que invocou uma REST API e enviou informações entre o Automation Pipelines e outro aplicativo usando o plug-in REST.

O que Fazer Depois

Continue a usar tarefas REST nos pipelines para executar comandos e integrar o Automation Pipelines a outros aplicativos para poder desenvolver e fornecer seus aplicativos de software. Considere o uso de tarefas de sondagem que pesquisam a API até que ela seja concluída e a tarefa de pipeline atenda aos critérios de saída.