Todos os produtos
Search

Este produto

    API Gateway:Manage REST APIs

    Central de documentação

    API Gateway:Manage REST APIs

    Última atualização: Jun 27, 2026

    Publique, importe, exporte e despublique APIs REST no console do Cloud-native API Gateway. Você também pode gerar um SDK e a documentação correspondente com um único clique.

    Publicar uma API

    Pré-requisitos

    Antes de publicar uma API, verifique se as operações estão definidas e criadas.

    Procedimento

    O Cloud-native API Gateway oferece suporte a dois tipos de API: APIs compartilhadas e APIs com escopo de instância.

    Shared API

    1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

    2. Clique em o nome da API desejada. No canto superior direito, clique em Publish.

    3. No painel Publish API, configure os parâmetros e clique em Publish.

      Parâmetro

      Descrição

      Domain Name

      Selecione um nome de domínio. A API ficará acessível por meio desse domínio após a publicação.

      Se não houver nenhum nome de domínio disponível, clique em Add Domain Name. Para mais informações, consulte Criar um nome de domínio.

      Instance

      Selecione uma instância de gateway. Use instâncias diferentes para isolar ambientes.

      Scenario

      Os cenários incluem publicação básica e canary release. Para tipos de serviço de backend, consulte Roteamento.

      Cenários básicos

      • Mock: Retorna uma resposta simulada com base na configuração de mock da operação. Operações sem configuração de mock ficam inacessíveis.

        Nota

        Para publicar no cenário de mock, pelo menos uma operação deve ter a configuração de mock ativada. Caso contrário, a publicação falhará.

      • Single Service: Encaminha todas as solicitações para um único serviço de backend. Este é o caso de uso mais comum.

      Cenários de canary release

      • By Percentage (Multi-service): Distribui o tráfego para serviços de backend por porcentagem. Ideal para deslocamento de tráfego e canary releases.

        Nota

        A soma dos pesos de todos os serviços deve ser 100.

      • By Content (Multi-service): Roteia o tráfego para diferentes serviços de backend com base em condições de correspondência. A regra marcada como Default lida com o tráfego não correspondido.

        • Tipos de correspondência suportados: Equal, Prefix e Regex.

        • Locais de parâmetros suportados: Query e Header.

        Múltiplas condições são combinadas usando lógica AND.

        Importante

        Apenas uma regra pode ser definida como Default. Todas as outras regras devem ter uma condição de correspondência não vazia.

      • By Tag (Proportion-based Routing): Distribui o tráfego por porcentagem entre versões de múltiplos serviços de backend. Para canary releases de ponta a ponta, recomenda-se o roteamento de serviço único.

      Backend Services

      Associe um serviço de backend no gateway ou na VPC. Se nenhum estiver disponível, clique em Create Service para Criar um serviço.

      Publish Description

      Insira uma descrição para esta publicação.

    Instance-scoped API

    1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

    2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

    3. No canto superior direito, clique em Publish. No painel Publish API, configure os parâmetros e clique em Publish.

      Parâmetro

      Descrição

      Instance

      Instância onde a API será publicada. Use instâncias diferentes para isolar ambientes.

      VPC

      VPC onde a instância está localizada.

      Publish Scope

      Escopo das operações da API a serem publicadas. Clique em o nome de uma operação para visualizar detalhes.

      Publish Description

      Insira uma descrição para esta publicação.

    Adicionar uma versão de API

    Importante

    Atualmente, só é possível adicionar versões a APIs compartilhadas.

    1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API e, na barra de navegação superior, selecione uma região.

    2. Clique em a API desejada. No canto superior direito, selecione More > Add Version e configure os seguintes parâmetros:

      Parâmetro

      Descrição

      Usage

      Métodos suportados: Path, Query e Header.

      Nota

      • Se você selecionar Query como Usage, deverá configurar o parâmetro Add Query.

      • Se você selecionar Header como Usage, deverá configurar o parâmetro Add Header.

      • Ao usar o método Path, o caminho completo da solicitação deve ser: /APIBasePath/VersionNumber/OperationPath.

      • Ao usar o método Query, utilize o caminho /APIBasePath/OperationPath e inclua o número da versão no parâmetro de consulta especificado em Add Query.

      • Ao usar o método Header, utilize o caminho /APIBasePath/OperationPath e inclua o número da versão no cabeçalho da solicitação especificado em Add Header.

    3. (Opcional) Após adicionar a versão, clique em a aba Version na parte superior da página para alternar entre as versões.

    Visualizar histórico de publicações

    Nota

    Os últimos 10 registros de publicação são mantidos.

    1. Visualize o histórico de publicações para APIs compartilhadas ou APIs com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada e clique em a aba Publish History.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API, clique em a API alvo e clique em a aba Publish History.

    2. Na coluna Actions de uma versão histórica, clique em View para ver seus detalhes.

    Gerar um SDK e documentação

    1. Gere um SDK e documentação para APIs compartilhadas ou APIs com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada. No canto superior direito, selecione More > Generate SDK & Documentation.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

      3. No canto superior direito, selecione More > Generate SDK & Documentation.

    2. Na caixa de diálogo More > Generate SDK & Documentation, configure os parâmetros e clique em Generate and Download.

      Parâmetro

      Descrição

      API Version

      Selecione a versão da API para geração do SDK e da documentação.

      Nota

      • APIs com escopo de instância não oferecem suporte a versionamento, portanto, esta opção não está disponível.

      • Para APIs compartilhadas, esta opção só estará disponível se você tiver ativado o gerenciamento de versões ao criar a API.

      Language

      Linguagens de SDK suportadas: Java, Golang, Python, Node.js, TypeScript e Swift.

    3. O pacote compactado será baixado automaticamente para a pasta padrão do seu navegador.

      Nota

      Após descompactar o pacote, consulte o arquivo README.md para obter instruções de uso do SDK.

    Importar uma API

    1. Importe uma definição de API para APIs compartilhadas ou APIs com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada. No canto superior direito, selecione More > Import.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

      3. No canto superior direito, selecione More > Import.

    2. No painel Create File based on OpenAPI, configure os parâmetros e clique em Precheck and Create.

    Exportar uma API

    1. Exporte uma definição de API para APIs compartilhadas ou APIs com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada. No canto superior direito, selecione More > Import.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

      3. No canto superior direito, selecione More > Import.

    2. Na caixa de diálogo Export, clique em OK. A definição da API será baixada para a pasta de downloads padrão do seu navegador.

    Despublicar uma API

    Importante

    Após despublicar uma API, suas operações tornam-se inacessíveis pelos nomes de domínio associados. As solicitações deixam de ser processadas, mas a configuração e o histórico de publicações são mantidos. Prossiga com cautela.

    1. Despublique uma API compartilhada ou uma API com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada. No canto superior direito, selecione More > Shutdown.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

      3. No canto superior direito, selecione More > Shutdown.

    2. Na caixa de diálogo Confirm Unpublish, clique em Shutdown.

    Excluir uma API

    Importante

    • Antes de excluir uma API publicada, despublique-a de todas as instâncias.

    • A exclusão de uma API remove permanentemente sua configuração, documentação e histórico. Esta ação não pode ser desfeita. Prossiga com cautela.

    1. Exclua uma API compartilhada ou uma API com escopo de instância.

      Shared API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha API. Na barra de navegação superior, selecione uma região.

      2. Clique em a API desejada. No canto superior direito, selecione More > Delete.

      Instance-scoped API

      1. Faça login no console do Cloud-native API Gateway. No painel de navegação à esquerda, escolha Instance. Na barra de navegação superior, selecione uma região.

      2. Na página Instance, clique em o ID da instância de gateway desejada. No painel de navegação à esquerda, escolha API e clique em a API alvo.

      3. No canto superior direito, selecione More > Delete.

    2. Na caixa de diálogo Confirm deletion, clique em Delete.