Publicação de uma API
Cenário
As APIs só podem ser chamadas depois de terem sido publicadas em um ambiente. Você pode publicar APIs em diferentes ambientes. O APIG permite que você visualize o histórico de publicações (como a versão, a descrição, a hora e o ambiente) de cada API e suporta a reversão de APIs para diferentes versões históricas.
- Se você modificar uma API publicada, deverá publicá-la novamente para que as modificações entrem em vigor no ambiente em que a API foi publicada.
- Um máximo de 10 registros de publicação de uma API são retidos em um ambiente.
Pré-requisitos
- Você criou um grupo de API e uma API.
- Você criou um ambiente.
Publicação de uma API
- Acesse o console de gerenciamento.
- Clique em no canto superior esquerdo e selecione uma região.
- Clique em no canto superior esquerdo e escolha API Gateway.
- Escolha um tipo de gateway no painel de navegação.
- Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
- Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.
- No painel de navegação, escolha API Publishing > APIs.
- Publique uma API. Você pode usar um dos seguintes métodos:
- Clique em Publish na linha que contém a API que você deseja publicar.
- Clique no nome da API de destino e clique em Publish no canto superior direito da página de detalhes da API exibida.
Para publicar várias APIs, selecione as APIs e clique em Publish. Você pode publicar no máximo 1.000 APIs por vez.
- Selecione o ambiente onde a API será publicada e insira uma descrição.
Figura 1 Publicação de uma API
- Se a API já tiver sido publicada no ambiente, publicá-la novamente substituirá sua definição nesse ambiente.
- Se não houver um ambiente que atenda aos seus requisitos, crie um novo.
- Clique em Publish.
Visualizar o histórico de publicações
- Acesse o console de gerenciamento.
- Clique em no canto superior esquerdo e selecione uma região.
- Clique em no canto superior esquerdo e escolha API Gateway.
- Escolha um tipo de gateway no painel de navegação.
Shared Gateway: você pode criar e gerenciar APIs imediatamente. Você será cobrado com base no número de chamadas de API.
Dedicated Gateways: você pode criar e gerenciar APIs depois de comprar um gateway. Você será cobrado com base na duração de uso do gateway.
- No painel de navegação, escolha API Publishing > APIs.
- Clique no nome da API de destino.
- Clique na guia Publication History.
O histórico de publicações da API é exibido.
Figura 2 Visualizar o histórico de publicações
- Clique em View Details na coluna Operation de uma versão.
A caixa de diálogo View Details exibe as informações básicas, informações de solicitação de front-end e back-end, parâmetros de entrada e constantes, mapeamentos de parâmetros e respostas de exemplo da API.
- Para reverter a API para uma versão histórica, clique em Switch Version na linha que contém a versão de destino e clique em Yes.
Se a "versão atual" for exibida ao lado da versão de destino, a reversão foi bem-sucedida.
Quando a API é chamada, a configuração da versão atual é usada em vez da configuração salva anteriormente.
Por exemplo, uma API foi publicada no ambiente RELEASE em 1º de agosto de 2018. Em 20 de agosto de 2018, a API foi publicada no mesmo ambiente após modificação. Se a versão publicada em 1º de agosto for definida como a versão atual, a configuração dessa versão será usada quando a API for chamada.
Publicar uma API chamando uma API
Você também pode publicar uma API chamando uma API fornecida pelo APIG. Para obter detalhes, consulte a seguinte referência: