AWS Variabili per l'importazione OpenAPI - Amazon API Gateway
Esempio di variabili AWS

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWS Variabili per l'importazione OpenAPI

È possibile utilizzare le seguenti variabili AWS nelle definizioni OpenAPI. API Gateway risolve le variabili quando l'API viene importata. Per specificare una variabile, utilizzare ${variable-name}. Nella seguente tabella vengono descritte le variabili AWS disponibili.

Nome della variabile Descrizione
AWS::AccountId L'ID account AWS che importa l'API. Ad esempio, 123456789012.
AWS::Partition La partizione AWS in cui viene importata l'API. Per le Regioni AWS standard, la partizione è aws.
AWS::Region La Regione AWS in cui viene importata l'API. Ad esempio us-east-2.

Esempio di variabili AWS

Nell'esempio seguente vengono utilizzate le variabili AWS per specificare una funzione AWS Lambda per un'integrazione.

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