AWS variables pour Open API import - APIPasserelle Amazon
AWS exemple de variables

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS variables pour Open API import

Vous pouvez utiliser les AWS variables suivantes dans API les définitions ouvertes. APIGateway résout les variables lors de API l'importation. Pour spécifier une variable, utilisez ${variable-name}. Le tableau suivant décrit les AWS variables disponibles.

Nom de variable Description
AWS::AccountId L'identifiant du AWS compte qui importe leAPI. Par exemple, 123456789012.
AWS::Partition La AWS partition dans laquelle le API est importé. Pour les AWS régions standard, la partition estaws.
AWS::Region AWS Région dans laquelle le API est importé. Par exemple, us-east-2.

AWS exemple de variables

L'exemple suivant utilise des AWS variables pour spécifier une AWS Lambda fonction 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