Tester les plans d'utilisation de REST APIs dans API Gateway

À titre d'exemple, utilisons l' PetStore API, qui a été créée dansDidacticiel : création d’une API REST par l’importation d’un exemple. Supposons que l’API est configurée pour utiliser la clé d’API Hiorr45VR...c4GJc. Les étapes suivantes expliquent comment tester un plan d’utilisation.

Pour tester votre plan d’utilisation

• Envoyez une demande GET sur la ressource Pets (/pets), avec les paramètres de requête ?type=...&page=... de l’API (par exemple, xbvxlpijch) dans un plan d’utilisation :

  GET /testStage/pets?type=dog&page=1 HTTP/1.1
  x-api-key: Hiorr45VR...c4GJc
  Content-Type: application/x-www-form-urlencoded
  Host: xbvxlpijch.execute-api.ap-southeast-1.amazonaws.com
  X-Amz-Date: 20160803T001845Z
  Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160803/ap-southeast-1/execute-api/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-api-key, Signature={sigv4_hash}
  

  Note

  Vous devez envoyer cette demande au composant execute-api d’API Gateway et fournir la clé d’API requise (par exemple, Hiorr45VR...c4GJc) dans l’en-tête x-api-key requis.

  La réponse positive renvoie un code de statut 200 OK et une charge utile qui contient les résultats demandés obtenus du backend. Si vous oubliez de définir l’en-tête x-api-key ou si vous le définissez avec une clé incorrecte, vous obtenez une réponse 403 Forbidden. Toutefois, si vous n’avez pas configuré la méthode pour exiger une clé d’API, vous obtiendrez probablement une réponse 200 OK que vous définissiez l’en-tête x-api-key correctement ou non, et les limites de quota et de restriction du plan d’utilisation seront ignorées.

  Parfois, lorsqu’une erreur interne se produit qui empêche API Gateway d’appliquer les limitations de plan d’utilisation ou les quotas pour la demande, API Gateway traite la demande sans appliquer les limitations ou les quotas comme indiqué dans le plan d’utilisation. En revanche, il consigne un message d'erreur Usage Plan check failed due to an internal error dans CloudWatch. Vous pouvez ignorer ces erreurs occasionnelles.