Variáveis da AWS para importação de OpenAPI - Amazon API Gateway
Exemplo de variáveis da AWS

Variáveis da AWS para importação de OpenAPI

Você pode usar as seguintes variáveis da AWS nas definições do OpenAPI. O API Gateway resolve as variáveis quando a API é importada. Para especificar uma variável, use ${variable-name}. A tabela a seguir descreve as estatísticas da AWS disponíveis.

Nome da variável Descrição
AWS::AccountId O ID da conta AWS que importa a API. Por exemplo, 123456789012.
AWS::Partition A partição da AWS na qual a API é importada. Para regiões padrão da AWS a partição é aws.
AWS::Region A região da AWS na qual a API é importada. Por exemplo, us-east-2.

Exemplo de variáveis da AWS

O exemplo a seguir usa variáveis da AWS para especificar uma função do AWS Lambda para uma integração.

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