Informazioni su REST
Esistono due modi per richiamare l'API:
- Inviare richieste HTTP e analizzarne le risposte.
- Utilizzare le librerie client.
Se decidi di non utilizzare le librerie client, è necessario che tu conosca le nozioni di base di REST.
Nozioni di base su REST
REST è un tipo di architettura software che fornisce un approccio pratico e coerente per la richiesta e la modifica dei dati.
Il termine REST è l'acronimo di "REpresentational State Transfer". Nel contesto delle API di Google, si riferisce all'utilizzo dei verbi HTTP per recuperare e modificare le rappresentazioni dei dati archiviati da Google.
In un sistema RESTful, le risorse vengono archiviate in un datastore. Un client invia una richiesta affinché il server esegua una determinata azione (ad esempio la creazione, il recupero, l'aggiornamento o l'eliminazione di una risorsa) e il server esegue l'azione e invia una risposta, spesso sotto forma di rappresentazione della risorsa specificata.
Nelle API RESTful di Google, il client specifica un'azione mediante un verbo HTTP come POST, GET, PUT o DELETE. La risorsa viene specificata tramite un URI globalmente univoco con il seguente formato:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Poiché tutte le risorse dell'API dispongono di URI univoci accessibili tramite HTTP, REST consente la memorizzazione dei dati nella cache ed è ottimizzato per operare con l'infrastruttura distribuita del Web.
Potresti trovare utili le definizioni dei metodi nella documentazione degli standard HTTP 1.1, che include le specifiche per GET, POST, PUT e DELETE.
REST nell'API Compute Engine
Le operazioni dell'API Compute Engine vengono mappate direttamente ai verbi HTTP REST.
L'API Compute Engine utilizza il seguente formato per gli URI:
https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH
L'URI contiene i seguenti valori:
API_VERSION: la versione dell'API che vuoi utilizzare, che corrisponde alla fase di lancio di una risorsa Compute Engine come segue:
- Per le risorse in GA:
v1
- Per le risorse in Anteprima pubblica:
beta
- Per le risorse in anteprima privata:
alpha
RESOURCE_PATH: il percorso della risorsa Compute Engine specifica, ad esempio projects/example-project/aggregated/instances. Per
visualizzare le risorse disponibili per ogni versione dell'API, consulta quanto segue:
Se vuoi includere parametri di ricerca, includili nell'URI dopo un punto interrogativo
(?):
https://www.googleapis.com/compute/API_VERSION/RESOURCE_PATH?QUERY_PARAMETERS
Nell'URI, QUERY_PARAMETERS è un elenco di parametri di ricerca separati da e commerciali (&), ad esempio format=json&filter=zone=us-central1-a.