Exportación de una API HTTP desde API Gateway - Amazon API Gateway
Exportación de una definición de OpenAPI 3.0 de una etapa mediante la AWS CLIExportación de una definición de OpenAPI 3.0 de los últimos cambios de la API mediante la AWS CLIExportación de una definición de OpenAPI 3.0 mediante la consola de API Gateway

Exportación de una API HTTP desde API Gateway

Después de crear una API HTTP, puede exportar una definición de OpenAPI 3.0 de su API desde API Gateway. Puede elegir una etapa que exportar o exportar la configuración más reciente de su API. También puede importar una definición de API exportada a API Gateway para crear otra API idéntica. Para obtener más información sobre la importación de definiciones de API, consulte Importación de una API HTTP.

Exportación de una definición de OpenAPI 3.0 de una etapa mediante la AWS CLI

El siguiente comando exporta una definición de OpenAPI de una etapa de API denominada prod a un archivo YAML denominado stage-definition.yaml. El archivo de definición exportado incluye extensiones de API Gateway de forma predeterminada.

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

Exportación de una definición de OpenAPI 3.0 de los últimos cambios de la API mediante la AWS CLI

El siguiente comando exporta una definición de OpenAPI de una API HTTP a un archivo JSON denominado latest-api-definition.json. Dado que el comando no especifica una etapa, API Gateway exporta la configuración más reciente de la API, con independencia de que se haya implementado en una etapa o no. El archivo de definición exportado no incluye extensiones de API Gateway.

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

Para obtener más información, consulte ExportAPI en la Referencia de la API de Amazon API Gateway Versión 2.

Exportación de una definición de OpenAPI 3.0 mediante la consola de API Gateway

El procedimiento siguiente describe cómo exportar una definición de OpenAPI de una API HTTP.

Para exportar una definición de OpenAPI 3.0 con la consola de API Gateway

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. Elija una API HTTP.

  3. En el panel de navegación principal, en Desarrollar, elija Exportar.

  4. Seleccione una de las siguientes opciones para exportar la API:

    Opciones de exportación para las API HTTP.

    1. En Origen, seleccione un origen para la definición de OpenAPI 3.0. Puede elegir una etapa que exportar o exportar la configuración más reciente de la API.

    2. Active Incluir extensiones de API Gateway para incluir las extensiones de API Gateway.

    3. En Formato de salida, seleccione un formato de salida.

  5. Elija Descargar.