Criando, Editando e Excluindo APIs

Para adicionar uma nova API manualmente, você pode clicar no botão Create API, representado pelo ícone + no canto inferior direito da tela. Se você somente deixar o cursor sobre o botão, outras três opções aparecerão:

Ao todo, portanto, você tem estas quatro formas de criar uma API:

Após a escolha de uma das opções citadas acima, a tela de cadastro será exibida e os campos obrigatórios devem ser preenchidos (com exceção da opção de importar um arquivo Swagger, que já cria a API, com a possibilidade de editar os campos). A tela de cadastro manual de API é esta aqui:

Se já houver algum ambiente cadastrado em Environments, a opção Deployable Environments será exibida. Caso contrário, o ambiente pode ser adicionado posteriormente (leia mais sobre eles nesta seção).

A opção Access token expires in determina o período de tempo de expiração do token para uma determinada API. Caso você não estabeleça um valor, o tempo padrão (10 segundos) será válido.

A opção Context está relacionada à visibilidade da sua API, que será exibida apenas para os usuários autorizados. As opções são:

Todos os usuários existentes no API Manager serão exibidos. Para alterar a permissão de um usuário específico, basta escolher entre as opções Can view (pode visualizar) ou Can edit (pode editar).

Embora a opção Can edit conceda ao usuário selecionado a permissão para editar as informações da API, essa permissão não ultrapassará as regras de acesso que foram definidas nas configurações de papel (role) desse usuário.

A opção Private API,quando marcada, não permite que a API esteja disponível para consumo no Portal de Desenvolvedores.

Ao clicar em Save and next, os dados básicos da API serão salvos. Os dois próximos passos (Resources e Flows) não são obrigatórios (porém, se a importação de um Swagger tiver sido efetuada anteriormente, os dados dos recursos já estarão preenchidos). Para maiores detalhes, acesse as páginas sobre Resources and Flows.

A última etapa na criação da API é a tela Publish:

Nela é possível realizar o deploy da API, caso a opção Environments tenha sido selecionada no início do cadastro. É possível também criar templates de teste, que gerarão um plano e uma app para serem vinculados à API cadastrada. Essa opção possibilitará o uso imediato da sua API.

Depois de cadastradas, as APIs ficam dispostas em cards (leia mais sobre os cards aqui).

Para ter acesso à tela de edição e exclusão da API, clique sobre o card. Você será direcionado para a tela de Overview. As informações podem ser editadas clicando-se no botão Edit. No canto inferior direito, há o botão Delete, para excluir a API. Veja mais informações sobre a tela de Overview aqui.

É possível criar APIs a partir da importação de arquivos de documentação que sigam a especificação OpenAPI. As versões da especificação aceitas são: Swagger 2.0 ou OpenAPI 3.0.0.

Para fazer isso, passe o cursor sobre o botão + no canto inferior direito da tela APIs e clique na opção IMPORT API DOCUMENT. A seguinte janela modal será aberta:

Digite um nome e versão para a API que será criada e clique em SELECT FILE para escolher um arquivo de sua máquina para importar. Os formatos aceitos são JSON e YAML.