Exportar uma API HTTP do API Gateway - Amazon API Gateway

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Exportar uma API HTTP do API Gateway

Depois de criar uma API HTTP, é possível exportar uma definição do OpenAPI 3.0 da API a partir do API Gateway. Você pode escolher um estágio para exportar ou exportar a configuração mais recente da API. Também é possível importar uma definição de API exportada para o API Gateway para a criação de outra API idêntica. Para saber mais sobre a importação de definições de API, consulte Importar uma API HTTP.

Exportar uma definição do OpenAPI 3.0 de um estágio usando a CLI da AWS

O comando a seguir exporta uma definição do OpenAPI de um estágio de API chamado prod para um arquivo YAML denominado stage-definition.yaml. O arquivo de definição exportado inclui extensões do API Gateway por padrão.

aws apigatewayv2 export-api \ --api-id api-id \ --output-type YAML \ --specification OAS30 \ --stage-name prod \ stage-definition.yaml

Exporte uma definição do OpenAPI 3.0 das alterações mais recentes da API usando a CLI da AWS

O comando a seguir exporta uma definição do OpenAPI de uma API HTTP para um arquivo JSON denominado latest-api-definition.json. Como o comando não especifica um estágio, o API Gateway exporta a configuração mais recente da API, quer ela tenha sido implantada em um estágio ou não. O arquivo de definição exportado não inclui extensões do API Gateway.

aws apigatewayv2 export-api \ --api-id api-id \ --output-type JSON \ --specification OAS30 \ --no-include-extensions \ latest-api-definition.json

Para obter mais informações, consulte ExportAPI na Referência de API do Amazon API Gateway versão 2.

Exportar uma definição do OpenAPI 3.0 usando o console do API Gateway

O procedimento a seguir mostra como exportar uma definição do OpenAPI de uma API HTTP.

Como exportar uma definição do OpenAPI 3.0 usando o console do API Gateway
  1. Inicie uma sessão no console do API Gateway em https://console.aws.amazon.com/apigateway.

  2. Selecione uma API HTTP.

  3. No painel de navegação principal, em Desenvolver, escolha Exportar.

  4. Selecione uma das seguintes opções para exportar a API:

    
          Opções de exportação para APIs HTTP.
    1. Em Origem, selecione uma origem para a definição do OpenAPI 3.0. Você pode escolher um estágio para exportar ou exportar a configuração mais recente da API.

    2. Ative a opção Incluir extensões do API Gateway para incluir extensões do API Gateway.

    3. Em Formato de saída, selecione um formato de saída.

  5. Escolha Download.