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.
Vous pouvez utiliser les AWS variables suivantes dans les définitions d'OpenAPI. API Gateway résout les variables lorsque l’API est importée. Pour spécifier une variable, utilisez ${. Le tableau suivant décrit les AWS variables disponibles. variable-name}
| Nom de la variable | Description |
|---|---|
AWS::AccountId |
L'ID du AWS compte qui importe l'API. Par exemple, 123456789012. |
AWS::Partition |
AWS Partition dans laquelle l'API est importée. Pour les AWS régions standard, la partition estaws. |
AWS::Region |
AWS Région dans laquelle l'API est importée. 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.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
