Estrutura de diretórios

Os serviços de API geralmente usam arquivos .proto para definir a superfície da API e arquivos .yaml a fim de configurar o serviço dela. Cada serviço de API precisa ter um diretório dentro de um repositório de APIs que contenha os arquivos de definição e scripts de compilação.

Cada diretório da API terá o seguinte layout padrão:

  • Diretório da API

    • Pré-requisitos do repositório

      • BUILD - arquivo de criação
      • METADATA - arquivo de metadados de criação;
      • OWNERS - proprietários do diretório da API
    • Arquivos de configuração

      • {service}.yaml: arquivo de configuração do serviço do valor de referência, que é a representação YAML da mensagem do proto google.api.Service.
      • prod.yaml - arquivo de configuração do serviço delta prod.
      • staging.yaml - arquivo de configuração do serviço delta staging.
      • test.yaml - arquivo de configuração do serviço delta test.
      • local.yaml - arquivo de configuração do serviço delta local.
    • Arquivos de documentação

      • README.md - arquivo readme principal. Conterá a visão geral da produção, descrição técnica etc.
      • doc/* - arquivos de documentação técnica. Eles estarão no formato Markdown.
    • Definições de interface

      • v[0-9]*/* - cada um desses diretórios contém uma versão importante da API, principalmente os arquivos proto e os scripts de criação.
      • {subapi}/v[0-9]*/* - cada diretório {subapi} contém a definição da interface de uma sub-API. Cada uma delas pode ter sua própria versão principal independente.
      • type/* - arquivos proto que contêm tipos que são compartilhados entre diferentes APIs, diferentes versões da API ou entre implementação do serviço e a API. As definições de tipo em type/* não podem ter alterações significativas depois de serem lançadas.
Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…