Einrichten einer Edge-optimierte API durch das Importieren von OpenAPI-Definitionen

Sie können eine API Gateway-API einrichten, indem Sie OpenAPI-Definitionen der entsprechenden API Gateway-API-Entitäten angeben und die OpenAPI-Definitionen in API Gateway importieren.

Die folgenden OpenAPI-Definitionen beschreiben die einfache API, wobei nur die GET /-Methode verwendet wird, die in einen HTTP-Endpunkt der PetStore-Website im Backend integriert ist und die Antwort 200 OK zurückgibt.

OpenAPI 2.0

{
  "swagger": "2.0",
  "info": {
    "title": "Simple PetStore (OpenAPI)"
  },
  "schemes": [
    "https"
  ],
  "paths": {
    "/pets": {
      "get": {
        "responses": {
          "200": {
            "description": "200 response"
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "GET",
          "type": "http"
        }
      }
    },
    "/pets/{petId}": {
      "get": {
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "200 response"
          }
        },
        "x-amazon-apigateway-integration": {
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "requestParameters": {
            "integration.request.path.id": "method.request.path.petId"
          },
          "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}",
          "passthroughBehavior": "when_no_match",
          "httpMethod": "GET",
          "type": "http"
        }
      }
    }
  }
}

Im folgenden Verfahren wird beschrieben, wie Sie diese OpenAPI-Definitionen über die API Gateway-Konsole in API Gateway importieren.

So importieren Sie die einfachen OpenAPI-Definitionen über die API Gateway-Konsole:

1. Melden Sie sich bei der API Gateway-Konsole an.

2. Wählen Sie Create API (API erstellen) aus.

3. Wählen Sie Import from OpenAPI.

4. Wenn Sie die oben genannten OpenAPI-Definitionen in einer Datei gespeichert haben, wählen Sie Select OpenAPI File. Sie können die OpenAPI-Definitionen auch kopieren und sie dann in den Import-Texteditor einfügen.

5. Wählen Sie Import, um den Import der OpenAPI-Definitionen abzuschließen.

Speichern Sie zum Importieren der OpenAPI-Definitionen mithilfe der AWS CLI die Swagger-Definitionen in einer Datei und führen Sie anschließend den folgenden Befehl aus, wobei davon ausgegangen wird, dass Sie die Region us-west-2 verwenden und dass der absolute OpenAPI-Dateipfad file:///path/to/API_OpenAPI_template.json ist:

aws apigateway import-rest-api --body 'file:///path/to/API_OpenAPI_template.json' --region us-west-2