Criar e Publicar API no Catálogo

Nesta seção, você encontra informações sobre criação e publicação de API no Catálogo.

Para registrar uma API no Catálogo, acesse o Catálogo de Serviços e siga os passos:

Passo 1. No canto inferior da tela, clique em 'Criar' e, em seguida, em 'API';

Passo 2. Na tela de 'Informações Básicas', preencha os campos de 'Nome' e 'Descrição';

Passo 3. Em 'Definição de API', você precisa:

Fazer o upload de um arquivo com o padrão OpenAPI (com extensões .yaml, .yml ou .json, nas versões 2.x, 3.0 e 3.1), já com os contratos da API.
Definir um ou mais ambientes em que a API será publicada.
Incluir a URL do Gateway em cada um dos ambientes definidos;

Em seguida, clique em 'Próximo';

Passo 4. Revise as informações da API e, se estiver tudo certo, clique em 'Criar API';

Passo 5. Na tela API criada, confira se os contratos estão corretos. Em seguida, clique em 'Publicar API'.

Pronto, você publicou uma API no Catálogo.

Para remover uma API publicada, clique em 'Reverter' e, logo em seguida, em 'Reverter API'.

Atenção!

Depois que uma API foi removida do Catálogo, não é possível publicá-la novamente. Ou seja, para publicar uma API com o mesmo conteúdo é preciso criá-la e publicá-la novamente.

Leia também