Configuration d'une API optimisée pour les périphériques en important des définitions OpenAPI

Vous pouvez configurer une API dans API Gateway en spécifiant des définitions OpenAPI d'entités d'API API Gateway appropriées et en important les définitions OpenAPI dans API Gateway.

Les définitions OpenAPI suivantes décrivent l'API simple, en exposant uniquement la GET / méthode intégrée à un point de terminaison HTTP du PetStore site Web dans le backend et en renvoyant une réponse. 200 OK

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

La procédure suivante décrit comment importer ces définitions OpenAPI dans API Gateway à l'aide de la console API Gateway.

Pour importer les définitions OpenAPI simples à l'aide de la console API Gateway

1. Connectez-vous à la console API Gateway à l'adresse : https://console.aws.amazon.com/apigateway.

2. Choisissez Créer une API, puis pour API REST, choisissez Importer.

3. Si vous avez enregistré les définitions OpenAPI précédentes dans un fichier, choisissez Choisir un fichier. Vous pouvez également copier les définitions OpenAPI et les coller dans l'éditeur de texte d'importation.

4. Pour Type de point de terminaison d'API, sélectionnez Optimisé pour la périphérie.

5. Choisissez Créer une API pour importer les définitions OpenAPI.

Pour importer les définitions OpenAPI à l'aide de AWS CLI, enregistrez les définitions OpenAPI dans un fichier, puis exécutez la commande suivante, en supposant que vous utilisez la us-west-2 région et que le chemin absolu du fichier OpenAPI est : file:///path/to/API_OpenAPI_template.json

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