AWSVariables pour l’importation OpenAPI

Vous pouvez utiliser les variables AWS suivantes dans les définitions OpenAPI. API Gateway résout les variables lorsque l’API est importée. Pour spécifier une variable, utilisez ${variable-name}. Le tableau suivant décrit les variables AWS disponibles.

Nom de la variable	Description
AWS::AccountId	ID de compte AWS qui importe l’API. Par exemple, 123456789012.
AWS::Partition	Partition AWS dans laquelle l’API est importée. Pour les régions AWS standard, la partition est aws.
AWS::Region	Région AWS dans laquelle l’API est importée. Par exemple, us-east-2.

Exemple de variables AWS

L’exemple suivant utilise des variables AWS pour spécifier une fonction AWS Lambda pour une intégration.

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