Structure des répertoires

Les services d'API utilisent généralement des fichiers .proto pour définir la surface de l'API et les fichiers .yaml permettant de configurer ces services. Chaque service d'API doit avoir un répertoire d'API à l'intérieur d'un dépôt d'API. Le répertoire de l'API devrait contenant 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 version
      • METADATA : le fichier des métadonnées de la version
      • OWNERS : les propriétaires du répertoire de l'API
      • README.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 proto google.api.Service
      • prod.yaml : le fichier de configuration du service delta de production
      • staging.yaml : le fichier de configuration du service delta de préproduction
      • test.yaml : le fichier de configuration du service delta de test
      • local.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 sous type/* 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. Pour en savoir plus sur la structure des répertoires, consultez la page Exemple d'API de l'infrastructure de service.