Configurando workflows

Esse artigo tem como objetivo explicar um pouco sobre os workflows na plataforma. Basicamente, o workflow é uma funcionalidade importante para o controle de APIs, sendo que, um workflow pode ser atribuido por teams ou organization.

A funcionalidade workflow encontra-se no menu na aba "governance" localizada no lado esquerdo da tela principal do manager.

mceclip0.png

Após clicar na funcionalidade, você será encaminhado para a seguinte tela abaixo:

mceclip1.png

Para criar um novo workflow, basta clicar no ícone de “ + “ localizado no canto inferior direito da tela.

mceclip2.png

Feito isso, será aberto uma tela na qual será preenchida com alguns campos obrigatórios (name, description e team).

mceclip0.png

Após preencher os dados, basta clicar no botão create workflow. Após realizar esse processo, temos o workflow criado no Stage One. Veja a imagem abaixo:

mceclip1.png

Abaixo segue algumas recomendações no momento da criação de um workflow:

  • Crie o primeiro estágio como uma tela em branco, para que todos os usuários possam cadastrar APIs sem restrições.
  • Sempre que você realizar alguma modificação na regra do workflow, deverá entrar nas APIs daquele estágio e salvá-las novamente, fazendo com que a nova regra seja aplicada.
  • A forma de utilizar os passos da API é utilizando sempre os environments que já possuem deploy, com isso é mais fácil para criar um fluxo developing -> Homolog -> Production.

Com o Stage one criado, podemos realizar algumas configurações clicando no ícone de engrenagem que está localizado no canto inferior direito do card, ou adicionar um novo Stage clicando no card com o símbolo de “ + “ que está localizado ao lado direito. Veja a imagem abaixo:

mceclip2.png

Como foi sugerido anteriormente, vamos deixar o primeiro estágio em branco e criaremos o segundo estágio. Neste, iremos criar algumas restrições ao clicar no ícone de engrenagem. 

Estas restrições podem ser configuradas usando interceptors, environments ou attributes.

Veja o exemplo abaixo:

mceclip6.png

Note na imagem acima, que estamos configurando o stage 2 com restrições de interceptor. Veja que, para atender as restrições do stage 2, a API deve conter o interceptor de Client ID Validation sendo executado na requisição, onde o mesmo pode estar inserido em qualquer posição no fluxo. 

Após realizadas as configurações, apenas é necessário clicar no botão de ADD REQUISITE, clicar no botão SAVE e habilitar a restrição configurada.

mceclip7.png

Veja na imagem abaixo que agora temos 2 Stages:

mceclip3.png

Feito isso, vamos criar uma API no Stage one, este está sem restrições. Isso por que, deixamos o mesmo em branco como foi recomendado anteriormente.

mceclip9.png

Veja que a API foi criada com sucesso.

mceclip10.png

 

Feito isso, acessamos a tela de configuração da API criada e tentamos fazer a edição da mesma para o Stage Two. No entanto, ao realizar o update da API, a plataforma retornou o seguinte erro:

mceclip11.png

Isso acontece, por que no Stage two temos requisitos configurados aos quais as APIs devem atender para poderem ser atualizadas para esse Stage. Sendo assim, para que a API possa ir para o Stage Two,foi necessário configurar o interceptor no fluxo de request da mesma. Desta forma, a API passa atender os requisitos configurados no stage em questão.

Após realizar essas configurações no fluxo de request da API, é possível realizar o update da mesma no próximo estágio. 

Veja as imagens abaixo:

mceclip12.png

 

No exemplo acima, foi criado um workflow com permissões de time. Caso queira criar um workflow com permissões de organization, basta clicar no card Organization WorkFlow.

mceclip13.png

Será criado o Stage One com todas as APIs cadastradas, e partir disso, será possível configurar as restrições do Stage 2 com as restrições desejadas. Veja a imagem abaixo:

mceclip14.png

Para concluir este artigo, vale lembrar que:

O Workflow da organização não pode ser excluído. Apenas podem ser deletados workflows que pertencem a times e que não estão sendo utilizados por nenhuma API.

Outro ponto importante que vale ressaltar é que, exceto o primeiro stage, todos os outros stages podem ser deletados. Visto que, um workflow sem Stage não existe.

 

 

 

 

Tem mais dúvidas? Envie uma solicitação

Comentários

Desenvolvido por Zendesk