Estructura de directorios

Por lo general, los servicios de API usan archivos .proto para definir la superficie de la API y archivos .yaml a fin de configurar el servicio de API. Cada servicio de API debe tener un directorio de API dentro de un repositorio de API que contenga sus archivos de definición y su secuencia de comandos de compilación.

Cada directorio de API debería tener el siguiente diseño estándar:

  • Directorio de API

    • Requisitos previos del repositorio

      • BUILD: el archivo de compilación
      • METADATA: el archivo de compilación de metadatos
      • OWNERS: los propietarios del directorio de API
    • Archivos de configuración

      • {service}.yaml: el archivo de configuración del servicio de referencia, que es una representación YAML de google.api.Service: mensaje de protocolo
      • prod.yaml: el archivo de configuración del servicio delta de producción
      • staging.yaml: el archivo de configuración del servicio delta de staging
      • test.yaml: el archivo de configuración del servicio delta de pruebas
      • local.yaml: el archivo de configuración del servicio delta local
    • Archivos de documentación

      • README.md: el archivo readme principal. Debería contener la descripción general de la producción general, la descripción técnica, etcétera
      • doc/*: los archivos de documentación técnica. Deberían estar en el formato Markdown
    • Definiciones de interfaz

      • v[0-9]*/*: cada directorio contiene una versión principal de la API, en particular, de los archivos de protocolo y la secuencia de comandos de compilación.
      • {subapi}/v[0-9]*/*: cada directorio {subapi} contiene la definición de interfaz de una subAPI. Cada subAPI puede tener su propia versión principal independiente.
      • type/*: archivos de protocolo que contienen tipos compartidos entre diferentes API, diferentes versiones de la misma API o entre la API y la implementación del servicio. Las definiciones de tipo en type/* no deberían tener cambios rotundos una vez que se lancen.
¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...