Un répertoire d'API typique contient des fichiers .proto, qui définissent la surface de l'API, et des fichiers .yaml, qui configurent le service d'API. Cette mise en page vous aide à maintenir des configurations de service et des interfaces versionnées cohérentes dans tous les environnements. Chaque service d'API doit disposer d'un répertoire d'API dans un dépôt d'API, et le répertoire d'API doit contenir tous les fichiers de définition d'API et les scripts de compilation.
Chaque répertoire d'API doit avoir la disposition standard suivante :
Répertoire d'API
Prérequis du dépôt
BUILD: le fichier de la versionMETADATA: le fichier des métadonnées de la versionOWNERS: les propriétaires du répertoire de l'APIREADME.md: les informations générales sur le service d'API
Fichiers de configuration
{service}.yaml: le fichier de configuration du service de référence, qui est la représentation YAML du message protogoogle.api.Serviceprod.yaml: le fichier de configuration du service delta de productionstaging.yaml: le fichier de configuration du service delta de préproductiontest.yaml: le fichier de configuration du service delta de testlocal.yaml: le fichier de configuration du service delta local
Fichiers de documentation
doc/*: les fichiers de documentation technique Ils devraient être au format Markdown
Définitions d'interface
v[0-9]*/*: chacun de ces répertoires contient une version majeure de l'API, principalement les fichiers proto et les scripts de compilation.{subapi}/v[0-9]*/*: chacun de ces répertoires{subapi}contient la définition d'interface d'une sous-API. Chaque sous-API peut posséder sa propre version majeure indépendante.type/*: les fichiers proto contenant des types partagés entre différentes API, différentes versions de la même API ou entre l'API et la mise en œuvre du service. Les définitions de type soustype/*ne devraient pas comporter de modifications destructives après leur publication.
Les définitions des API Google publiques sont publiées sur GitHub. Consultez le dépôt des API Google.