ディレクトリ構造

API サービスは通常、.proto ファイルを使用して API サーフェスを定義し、.yaml ファイルを使用して API サービスを構成します。各 API サービスで、API ディレクトリが API リポジトリ内にあることが必須となります。API ディレクトリには、API 定義ファイルとビルドスクリプトがすべて含まれる必要があります。

各 API ディレクトリは、次の標準レイアウトにすることが推奨されます。

API ディレクトリ
- リポジトリの前提条件
  - BUILD - ビルドファイル。
  - METADATA - ビルドメタデータファイル。
  - OWNERS - API ディレクトリのオーナー。
  - README.md - API サービスに関する一般的な情報。
- 構成ファイル
  - {service}.yaml - ベースラインサービス構成ファイル。これは google.api.Service proto メッセージの YAML 表現です。
  - prod.yaml - 本番デルタサービス構成ファイル。
  - staging.yaml - ステージングデルタサービス構成ファイル。
  - test.yaml - テストデルタサービス構成ファイル。
  - local.yaml - ローカルデルタサービス構成ファイル。
- ドキュメントファイル
  - doc/* - 技術ドキュメントファイル。Markdown 形式にします。
- インターフェース定義
  - v[0-9]*/* - 各ディレクトリには、API のメジャーバージョン（主に proto ファイルとビルドスクリプト）が含まれています。
  - {subapi}/v[0-9]*/* - 各 {subapi} ディレクトリにはサブ API のインターフェース定義が含まれています。各サブ API には独自のメジャーバージョンを持つことができます。
  - type/* - 異なる API 間、同じ API の異なるバージョン間、または API とサービスの実装間で共有される型を含む proto ファイル。type/* の下にある型定義には、リリース後に互換性を損なう変更を加えるべきではありません。

公開 Google API の定義は、GitHub で公開されています。Google API リポジトリをご覧ください。ディレクトリ構造の詳細については、Service Infrastructure のサンプル API をご覧ください。

命名規則

変更履歴