Google API 設計指南－目錄結構

翻譯自 API Design Guide - Directory Structure

一般使用 .proto 文件定義 API，使用 .yaml 文件作爲配置。

每一個 API 服務 必須（must） 有一個 API 目錄來存放定義文件和構建腳本。

API 目錄 應該（should） 遵循以下的標準結構：

• API 目錄

• 配置文件

  • {service}.yaml：主服務的配置文件，google.api.Service 的 YAML 格式

  • prod.yaml：產品環境配置文件

  • staging.yaml：Staging 環境配置文件

  • test.yaml：測試環境配置文件

  • local.yaml：本地環境配置文件

• 接口定義

  • v[0-9]*/*：每個子目錄包含 API 的一個主版本，主要存放原型文件和構建腳本

  • {subapi}/v[0-9]*/*：每個 {subapi} 目錄包含子 API 的接口定義。每一個子 API 能夠有它獨立的主版本號

  • type/*： 包含類型定義的原型文件，包括這些：在不一樣 API 間共享的類型、不一樣 API 版本間共享的類型或 API 與服務實現間共享的類型。一旦發佈，type/* 中定義的類型 不該該（should not） 有破壞兼容性的修改。

查看其餘章節