Consulte un archivo externo de OpenAPI especificaciones con Infrastructure Composer - AWS Infrastructure Composer

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Consulte un archivo externo de OpenAPI especificaciones con Infrastructure Composer

En este ejemplo, se utiliza Infrastructure Composer desde la consola para hacer referencia a un archivo de OpenAPI especificaciones externo que define una API GatewayREST API.

En primer lugar, cree un proyecto nuevo desde la página de inicio de Infrastructure Composer.

A continuación, active la sincronización local seleccionando Activar la sincronización local en el menú. Crea una nueva carpeta con un nombredemo, deja que el mensaje vea los archivos y selecciona Activar. Cuando se te pida, selecciona Guardar cambios.

Aparece la ventana de sincronización local Activate de Infrastructure Composer con una carpeta de proyecto de demostración seleccionada y el botón Activar listo para ser seleccionado.

A continuación, arrastra una tarjeta de Amazon API Gateway al lienzo. Seleccione Detalles para que aparezca el panel de propiedades del recurso.

Un recurso de API Gateway en el lienzo con el panel de propiedades del recurso abierto.

En el panel de propiedades del recurso, configura lo siguiente y guárdalo.

  • Seleccione la opción Usar un archivo externo para la definición de la API.

  • Ingrese ./api-spec.yaml como la ruta relativa al archivo externo

Una ventana que muestra la casilla de verificación marcada en Usar un archivo externo para la definición de la API y una ruta relativa a un archivo externo definido.

Esto crea el siguiente directorio en nuestra máquina local:

demo
└── api-spec.yaml

Ahora, puede configurar el archivo externo en nuestra máquina local. Con nuestro IDE, abra lo que api-spec.yaml se encuentra en la carpeta de su proyecto. Sustituya su contenido por lo siguiente:

openapi: '3.0'
info: {}
paths:
  /:
    get:
      responses: {}
    post:
      x-amazon-apigateway-integration:
        credentials:
          Fn::GetAtt:
            - ApiQueuesendmessageRole
            - Arn
        httpMethod: POST
        type: aws
        uri:
          Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:sqs:path/${AWS::AccountId}/${Queue.QueueName}
        requestParameters:
          integration.request.header.Content-Type: '''application/x-www-form-urlencoded'''
        requestTemplates:
          application/json: Action=SendMessage&MessageBody={"data":$input.body}
        responses:
          default:
            statusCode: 200
      responses:
        '200':
          description: 200 response

En la vista de plantillas de Infrastructure Composer, puede ver que Infrastructure Composer ha actualizado automáticamente la plantilla para hacer referencia al archivo externo.

La vista de plantilla de Infrastructure Composer muestra el código de infraestructura configurado para hacer referencia al archivo externo.