Invocazione di REST API in Gateway API - Amazon API Gateway
Ottenimento dell'URL di invocazione di un'APIInvocazione di un'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à.

Invocazione di REST API in Gateway API

Per chiamare un'API distribuita, i client inviano richieste all'URL del servizio del componente API Gateway per l'esecuzione dell'API, ovvero execute-api.

L'URL di base per le API REST si presenta nel formato seguente: 

https://api-id.execute-api.region.amazonaws.com/stage/

dove api-id è l'identificativo dell'API, region è la Regione AWS e stage è il nome della fase dell'implementazione dell'API.

Importante

Prima di invocare un'API, devi distribuirla in API Gateway. Per istruzioni sull'implementazione di un'API, consulta Implementa REST APIs in API Gateway.

Argomenti

Ottenimento dell'URL di invocazione di un'API

Per ottenere l'URL di invocazione di un'API è possibile utilizzare la console, AWS CLI o una definizione OpenAPI esportata.

Ottenimento dell'URL di invocazione di un'API tramite la console

La procedura seguente mostra come ottenere l'URL di invocazione di un'API tramite la console REST API.

Per ottenere l'URL di invocazione di un'API tramite la console REST API

  1. Accedere alla console API Gateway all'indirizzo https://console.aws.amazon.com/apigateway.

  2. Scegli un'API implementata.

  3. Nel riquadro di navigazione principale, seleziona Log.

  4. In Dettagli fase, scegli l'icona Copia per copiare l'URL di richiamo dell'API.

    Questo è l'URL per la risorsa root dell'API.

    Dopo aver creato la REST API, la console mostra il valore URL di richiamo dell'API.

  5. Per ottenere l'URL di invocazione per un'altra risorsa dell'API, espandi la fase nel pannello di navigazione secondario, quindi seleziona un metodo.

  6. Scegli l'icona Copia per copiare l'URL di invocazione a livello di risorsa dell'API.

    L'URL a livello di risorsa della REST API si trova nel pannello di navigazione secondario della fase.

Ottenimento dell'URL di invocazione di un'API tramite AWS CLI

La procedura seguente mostra come ottenere l'URL di invocazione di un'API tramite AWS CLI.

Per ottenere l'URL di invocazione di un'API tramite AWS CLI

  1. Esegui il comando seguente per ottenere il valore rest-api-id. Questo comando restituisce tutti i valori rest-api-id presenti nella Regione in uso. Per ulteriori informazioni, consulta get-rest-apis.

    aws apigateway get-rest-apis

  2. Sostituisci il valore rest-api-id di esempio con il valore rest-api-id da utilizzare, il valore {stage-name} di esempio con il valore {stage-name} da utilizzare, quindi sostituisci {region} con la Regione in uso.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Ottenimento dell'URL di invocazione di un'API tramite il file di definizione OpenAPI esportato dell'API

È possibile anche creare l'URL root combinando i campi host e basePath di un file di definizione OpenAPI esportato dell'API. Per istruzioni su come esportare l'API, consulta Esportazione di un'API REST da API Gateway.

Invocazione di un'API

È possibile chiamare l'API implementata utilizzando il browser, curl o altre applicazioni, come Postman.

Inoltre, è possibile utilizzare la console Gateway API per testare una chiamata API. Il test sfrutta la funzionalità TestInvoke di Gateway API, che consente di testare l'API prima che sia implementata. Per ulteriori informazioni, consultare Utilizzo della console API Gateway per il test di un metodo API REST.

Nota

I valori dei parametri delle stringe di query di un URL di chiamata non possono includere %%.

Invocazione di un'API tramite un browser web

Se l'API consente l'accesso anonimo, è possibile utilizzare qualsiasi browser web per invocare un metodo GET. Inserisci l'URL di invocazione completo nella barra degli indirizzi del browser.

Per altri metodi o chiamate che richiedono l'autenticazione, è necessario specificare un payload oppure firmare le richieste. Puoi gestire queste operazioni in uno script di una pagina HTML o in un'applicazione client utilizzando uno degli SDK AWS.

Invocazione di un'API tramite curl

Per chiamare l'API è possibile utilizzare uno strumento come curl nel terminale. Il seguente comando curl di esempio invoca il metodo GET sulla risorsa getUsers della fase prod di un'API.

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"