OpenAPI를 사용하여 프라이빗 통합이 포함된 API 설정 - Amazon API Gateway

OpenAPI를 사용하여 프라이빗 통합이 포함된 API 설정

API의 OpenAPI 파일을 가져와 프라이빗 통합이 포함된 API를 설정할 수 있습니다. 다음만 제외하면 설정은 HTTP 통합이 포함된 API의 OpenAPI 정의와 비슷합니다.

  • 명시적으로 connectionType을 VPC_LINK로 설정해야 합니다.

  • 명시적으로 connectionId를 VpcLink의 ID 또는 VpcLink의 ID를 참조하는 단계 변수로 설정해야 합니다.

  • 프라이빗 통합의 uri 파라미터는 VPC의 HTTP/HTTPS 엔드포인트를 가리키지만 그 대신 통합 요청의 Host 헤더를 설정하는 데 사용됩니다.

  • VPC에 HTTPS 엔드포인트가 있는 프라이빗 통합의 uri 파라미터는 VPC 엔드포인트에 설치된 인증서에 있는 이름과 대조하여 지정된 도메인 이름을 확인하는 데 사용됩니다.

단계 변수를 사용하여 VpcLink ID를 참조할 수 있습니다. 또는 ID 값을 직접 connectionId에 할당할 수 있습니다.

다음 JSON 형식의 OpenAPI 파일은 단계 변수(${stageVariables.vpcLinkId})가 참조하는 VPC 링크가 포함된 API의 예를 보여 줍니다.

OpenAPI 2.0
{
  "swagger": "2.0",
  "info": {
    "version": "2017-11-17T04:40:23Z",
    "title": "MyApiWithVpcLink"
  },
  "host": "p3wocvip9a.execute-api.us-west-2.amazonaws.com",
  "basePath": "/test",
  "schemes": [
    "https"
  ],
  "paths": {
    "/": {
      "get": {
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "200 response",
            "schema": {
              "$ref": "#/definitions/Empty"
            }
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "uri": "http://my-vpclink-test-nlb-1234567890abcdef.us-east-2.amazonaws.com",
          "passthroughBehavior": "when_no_match",
          "connectionType": "VPC_LINK",
          "connectionId": "${stageVariables.vpcLinkId}",
          "httpMethod": "GET",
          "type": "http_proxy"
        }
      }
    }
  },
  "definitions": {
    "Empty": {
      "type": "object",
      "title": "Empty Schema"
    }
  }
}