I servizi API in genere utilizzano i file .proto per definire la piattaforma API e i file .yaml per configurare il servizio API. Ogni servizio API deve avere una directory API all'interno di un repository API. La directory delle API deve contenere tutti i file di definizione delle API e creare script.
Ogni directory delle API deve avere il seguente layout standard:
Directory API
Prerequisiti del repository
BUILD: il file di build.METADATA: il file di metadati della build.OWNERS: i proprietari della directory dell'API.README.md: le informazioni generali sul servizio API.
File di configurazione
{service}.yaml: il file di configurazione del servizio di riferimento, che è la rappresentazione YAML del messaggio protogoogle.api.Service.prod.yaml: il file di configurazione del servizio delta prodotto.staging.yaml: il file di configurazione del servizio delta gestione temporanea.test.yaml: il file di configurazione del servizio delta di test.local.yaml: il file di configurazione del servizio delta locale.
File della documentazione
doc/*: i file della documentazione tecnica. Dovrebbero essere nel formato Markdown.
Definizioni dell'interfaccia
v[0-9]*/*: ogni directory di questo tipo contiene una versione principale dell'API, principalmente i file di protocollo e gli script di build.{subapi}/v[0-9]*/*: ogni directory{subapi}contiene una definizione di interfaccia di un'API secondaria. Ogni API secondaria può avere la propria versione principale indipendente.type/*: file di protocollo contenenti tipi condivisi tra API diverse, versioni diverse della stessa API o tra l'API e l'implementazione del servizio. Le definizioni dei tipi intype/*non devono avere modifiche che provocano errori dopo il rilascio.
Le definizioni delle API Google pubbliche vengono pubblicate su GitHub. Consulta il repository delle API di Google. Per i dettagli della struttura delle directory, consulta la pagina relativa all'API Service Infrastructure Example.