Test di piani di utilizzo per REST API in Gateway API - Gateway Amazon API

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Test di piani di utilizzo per REST API in Gateway API

Come esempio, usiamo l'API PetStore API, creata in Tutorial: creazione di un'API REST mediante l'importazione di un esempio. Presupponiamo che l'API sia configurata per l'uso della chiave API Hiorr45VR...c4GJc. La procedura seguente illustra come testare un piano di utilizzo.

Per testare il piano di utilizzo

  • Fai una richiesta GET nella risorsa Pets (/pets), con i parametri di query ?type=...&page=... dell'API (ad esempio, xbvxlpijch) in un piano di utilizzo:

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

    Devi inviare questa richiesta al componente execute-api di API Gateway e fornire la chiave API necessaria (ad esempio Hiorr45VR...c4GJc) nell'intestazione x-api-key obbligatoria.

    Se riesce, la risposta restituisce un codice di stato 200 OK e un payload contenente i risultati richiesti dal back-end: Se dimentichi di impostare l'intestazione x-api-key o se la imposti con una chiave sbagliata, ottieni una risposta 403 Forbidden. Tuttavia, se non hai configurato il metodo in modo che richieda una chiave API, probabilmente otterrai la risposta 200 OK, anche se imposti l'intestazione x-api-key in modo non corretto e se vengono superati i imiti di throttling e di quota del piano di utilizzo.

    A volte, quando si verifica un errore interno in cui API Gateway non riesce ad applicare i limiti di throttling o le quote del piano di utilizzo per la richiesta, API Gateway elabora la richiesta senza applicare i limiti di throttling o le quote specificate nel piano i utilizzo. Tuttavia, registra un messaggio di errore Usage Plan check failed due to an internal error in CloudWatch. Puoi ignorare questi errori occasionali.