Pular para o conteúdo principal

Criar e Publicar API

Nesta seção, você encontra como criar e publicar uma API.


Criar uma API

Para criar uma API no Catálogo, acesse o seu Workspace e siga os passos:

Passo 1. No menu esquerdo da tela, clique em 'APIs' e, em seguida, no botão 'Criar API', no canto superior direito da tela;

Passo 2. Na tela de 'Informações da Api', preencha os campos de 'Nome' e 'Descrição'. Em seguida, clique no botão 'Próximo`;

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.

  • Selecionar uma Connection Interface. Este é um passo opcional durante a criação, mas para publicar uma API, você precisa registrar ou já ter registrado uma Connection Interface.

  • 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'.

Pronto, você criou uma API.

Para editar uma API, siga os passos:

Editar uma API

Confira os campos que podem ser editados em uma API:

  • Nome: não pode ser alterado.
  • Descrição: não pode ser alterado.
  • OpenAPi File: pode ser alterado.
  • Connection Interface: se você não informá-la no cadastro da API, virá em branco. Neste caso, na edição é possível selecionar uma Connection Interface. Se a Connection Interface já foi informada no cadastro da API, esse campo não poderá ser alterado na edição.
  • Gateway URL: pode ser alterado.
Informação Adicional

Se o ambiente foi selecionado durante a criação da API, a edição será aplicada somente naquele ambiente.

Confira o passo a passo:

Passo 1. Acesse a seção de 'Configurações' da sua API;

Passo 2. Em 'Informações de API', clique em 'Editar';

Passo 3. Se necessário, edite os campos:

  • Importe um arquivo OpenAPI
  • Connection Interface
  • Gateway URL

Passo 4. Clique em 'Salvar'.

Pronto, você editou uma API.

Publicar uma API

Passo 1. No Workspace em que você criou a sua API, acesse a seção de APIs;

Passo 2. Clique na API que você criou e quer publicar;

Passo 3. Na tela API criada, confira se os contratos estão corretos. Em seguida, clique no botão 'Publicar API', no canto superior esquerdo da tela.

Atenção!

Caso você não tenha vinculado uma Connection Interface durante a criação da API, clique no botão 'Registrar connection interface' e siga os passos de edição da API.

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

Agora você pode utilizá-la e/ou vinculá-la a um Produto.

Despublicar uma API

Para despublicar uma API, acesse a sua API e clique no botão em 'Despublicar API'. Para confirmar, clique no botão 'Despublicar API'.

Atenção!

Depois que uma API foi despublicada 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