Variables de AWS para la importación de OpenAPI - Amazon API Gateway
Ejemplo de variables de AWS

Variables de AWS para la importación de OpenAPI

Puede utilizar las siguientes variables de AWS en las definiciones de OpenAPI. API Gateway resuelve las variables cuando se importa la API. Para especificar una variable, utilice ${variable-name}. En la siguiente tabla se describen las variables de AWS disponibles.

Nombre de variable Descripción
AWS::AccountId El ID de cuenta de AWS que importa la API. Por ejemplo: 123456789012.
AWS::Partition La partición de AWS en la que se importa la API. Para las regiones estándar de AWS, la partición es aws.
AWS::Region La región de AWS en la que se importa la API. Por ejemplo, us-east-2.

Ejemplo de variables de AWS

En el siguiente ejemplo, se utilizan variables de AWS para especificar una función de AWS Lambda para una integración.

OpenAPI 3.0
openapi: "3.0.1"
info:
  title: "tasks-api"
  version: "v1.0"
paths:
  /:
    get:
      summary: List tasks
      description: Returns a list of tasks
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
        500:
          description: "Internal Server Error"
          content: {}
      x-amazon-apigateway-integration:
        uri:
          arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:${AWS::Partition}:lambda:${AWS::Region}:${AWS::AccountId}:function:LambdaFunctionName/invocations
        responses:
          default:
            statusCode: "200"
        passthroughBehavior: "when_no_match"
        httpMethod: "POST"
        contentHandling: "CONVERT_TO_TEXT"
        type: "aws_proxy"
components:
  schemas:
    Task:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string