Pubblicato il 2017-02-21. Log delle modifiche
Introduzione
Questa è una guida generale alla progettazione di API in rete. È stato usato in Google dal 2014 ed è la guida che Google segue durante la progettazione delle API Cloud e di altre API di Google. Abbiamo condiviso questa guida alla progettazione per informare gli sviluppatori esterni e per rendere più semplice la collaborazione.
Gli sviluppatori di Cloud Endpoints potrebbero trovare particolarmente utile questa guida nella progettazione delle API gRPC, pertanto consigliamo vivamente di utilizzare questi principi di progettazione. Tuttavia, non ne viene imposto l'utilizzo. Puoi utilizzare Cloud Endpoint e gRPC senza seguire la guida.
Questa guida si applica sia alle API REST sia alle API RPC, con particolare attenzione alle API gRPC, che utilizzano i buffer di protocollo per definire la propria superficie API e la configurazione dei servizi API per configurare i propri servizi API, tra cui mappatura HTTP, logging e monitoraggio. Le funzionalità di mappatura HTTP vengono utilizzate dalle API di Google e dalle API gRPC di Cloud Endpoints per i protocolli JSON/HTTP e il buffer di protocollo/RPC transcodifica.
Questa guida è un documento vivente che verrà ampliato nel tempo con l'adozione e l'approvazione di nuovi stili e modelli di design. Nello spirito, non sarà mai completo e ci sarà sempre ampio spazio per l'arte e la creazione di API.
Convenzioni utilizzate in questa guida
La parola chiave di livello "requisito" DEVE "," "NON DEVE", "RICHIESTA"
In questo documento, tali parole chiave sono evidenziate utilizzando il carattere grassetto.
Sezioni
- Design orientato alle risorse
- Nomi delle risorse
- Metodi standard
- Metodi personalizzati
- Campi standard
- Errori
- Convenzioni di denominazione
- Pattern di progettazione
- Documentazione
- Utilizzare proto3
- Controllo delle versioni
- Compatibilità
- Struttura della directory
- Struttura del file
- Glossario