Richiama le API REST in API Gateway - Amazon API Gateway
Ottenere l'URL di richiamo 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à.

Richiama le API REST in API Gateway

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'identificatore dell'API, region è la AWS regione e stage è il nome di fase della distribuzione dell'API.

Importante

Prima di invocare un'API, devi distribuirla in API Gateway. Per istruzioni sulla distribuzione di un'API, consulta. Implementa le API REST in API Gateway

Argomenti

Ottenere l'URL di richiamo di un'API

È possibile utilizzare la console AWS CLI, la o una definizione OpenAPI esportata per ottenere l'URL di richiamo di un'API.

Ottenere l'URL di richiamo di un'API utilizzando la console

La procedura seguente mostra come ottenere l'URL di richiamo di un'API nella console dell'API REST.

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

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

  2. Scegli un'API distribuita.

  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 URL è per la risorsa principale della tua API.

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

  5. Per ottenere l'URL di richiamo di un'API per un'altra risorsa dell'API, espandi lo stage nel riquadro di navigazione secondario, quindi scegli un metodo.

  6. Scegli l'icona di copia per copiare l'URL di richiamo a livello di risorsa dell'API.

    L'URL a livello di risorsa per la tua API REST si trova nel pannello di navigazione secondario dello stage.

Ottenere l'URL di richiamo di un'API utilizzando il AWS CLI

La procedura seguente mostra come ottenere l'URL di richiamo di un'API utilizzando. AWS CLI

Per ottenere l'URL di richiamo di un'API utilizzando il AWS CLI

  1. Utilizzare il comando seguente per ottenere ilrest-api-id. Questo comando restituisce tutti rest-api-id i valori nella tua regione. Per ulteriori informazioni, vedere get-rest-apis.

    aws apigateway get-rest-apis

  2. Sostituisci l'esempio rest-api-id con il tuorest-api-id, sostituisci l'esempio {stage-name} con il tuo {stage-name} e sostituisci {region} con la tua Regione.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
Ottenere l'URL di richiamo di un'API utilizzando il file di definizione OpenAPI esportato dell'API

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

Invocazione di un'API

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

Inoltre, puoi utilizzare la console API Gateway per testare una chiamata API. Test utilizza la TestInvoke funzionalità di API Gateway, che consente il test delle API prima che l'API venga distribuita. Per ulteriori informazioni, consulta 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 %%.

Richiamo di un'API utilizzando un browser Web

Se la tua API consente l'accesso anonimo, puoi utilizzare qualsiasi browser Web per richiamare qualsiasi 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 o firmare le richieste. Puoi gestirle in uno script dietro una pagina HTML o in un'applicazione client utilizzando uno degli SDK. AWS

Invocare un'API usando curl

Puoi usare uno strumento come curl nel tuo terminale per chiamare la tua API. Il seguente comando curl di esempio richiama il metodo GET sulla getUsers risorsa dello prod stadio 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"