Como cadastrar uma API?

Para adicionar uma nova API, deve-se clicar em "Create API", botão no canto inferior direito (+):

Overview

A tela de cadastro será exibida e será habilitado um wizard para ajudar no cadastro. Nessa mesma tela, vamos preencher os campos iniciais. Repare na opção “I have a swagger file!”. Caso tenha um swagger, basta importá-lo para automatizar o processo da criação da API.

 

 

 

Atenção ao campo “Life Cycle”! Esse campo é importante porque é ele que define se sua API está realmente exposta e, se está, se ela já está em versões antigas.

  • Assembling: A API ainda está sendo descrita, podendo ocorrer alteração, portanto, a API não estará exposta;
  • Available: A API está concluída e exposta;
  • Deprecated: Usado para indicar que uma determinada API é de uma versão muito antiga, sendo assim, o usuário que utilizar um API Deprecated deve ter em mente que aquela versão já passou por muitas alterações, porém, continua exposta;
  • Retired: Utilizado para indicar que a API está descontinuada e não estará exposta.

Uma boa prática é, inicialmente, preencher esse campo com o valor “Assembling”, pois enquanto a API é construída, os dados não ficarão expostos.

Logo abaixo, vamos encontrar os campos: “Base path”, “URL” e “Destination”. Esses 3 campos merecem também, muita atenção. Eles serão os responsáveis pela rota principal de nossa API.

O campo “Base path” costuma-se colocar a versão de nossa API, para que seja identificável no momento em que ela é consumida. Isso é uma boa prática no design de APIs.

Logo abaixo, no campo URL, devemos preencher o endereço onde está instalado o Gateway do API Management Suite. É nele que as requisições irão “bater” e ser encaminhadas para suas respectivas rotas.

É possível criar uma API com múltiplas urls para Production e SandBox. O request das urls adicionadas na mesma API será direcionado para um único Backend pelo Gateway. Após o processamento o Gateway irá direcionar para a mesma URL DESTINATION no response.

Segue a descrição do fluxo:

 

Em APIs é possível adicionar, editar e excluir urls para Production e Sandbox.

Para adicionar basta informar uma url válida e clicar no botão "+ADD". Devem ser inseridas uma por vez.

Resources

Na próxima etapa, encontra-se os “Resources”. Nele será definido todos os recursos da API com cada método http desejado.

Para cadastrar um resource, deve-ser preencher o campo "Resource name" e clicar em "ADD RESOURCE". Uma boa prática para APIs, é utilizar o nome do recurso no plural. Exemplo: orders.

Flows

Na próxima etapa, encontra-se o "Flows" onde devem ser inseridos os interceptors. Não é obrigatório na criação de uma API, podendo ser inserido posteriormente.

Summary

A próxima e última etapa, temos o Summary. Nesta parte temos o resumo de todos os dados inseridos para a criação da API. Aqui podemos verificar se o cadastro está de acordo. Caso queira alterar algum passo, basta clicar no passo desejado através do wizard e alterar o item, senão apenas clique em 'PUBLISH YOUR API' para salvar.

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

Comentários

Powered by Zendesk