Richten Sie private Integrationen API mithilfe von Open ein API - APIAmazon-Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Richten Sie private Integrationen API mithilfe von Open ein API

Sie können eine API mit der privaten Integration einrichten, indem Sie die API API Open-Datei importieren. Die Einstellungen ähneln den API Open-Definitionen von an API with HTTP integrations, mit den folgenden Ausnahmen:

  • Sie müssen connectionType explizit auf VPC_LINK festlegen.

  • Sie müssen connectionId explizit auf die ID eines VpcLink oder auf eine Stufenvariable festlegen, die auf die ID eines VpcLink verweist.

  • Der uri Parameter in der privaten Integration zeigt auf einenHTTP/HTTPS-Endpunkt in derVPC, wird aber stattdessen verwendet, um den Host Header der Integrationsanfrage einzurichten.

  • Der uri Parameter in der privaten Integration mit einem HTTPS Endpunkt in VPC wird verwendet, um den angegebenen Domainnamen mit dem Namen im Zertifikat zu vergleichen, das auf dem VPC Endpunkt installiert ist.

Sie können eine Stufenvariable als Referenz auf die VpcLink-ID verwenden. Sie können den ID-Wert auch connectionId direkt zuweisen.

Die folgende API Open-Datei im JSON -Format zeigt ein Beispiel für eine API mit einem VPC Link, auf den eine Stufenvariable () ${stageVariables.vpcLinkId} verweist:

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"
    }
  }
}