ディレクトリ構造

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

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

  • API ディレクトリ

    • リポジトリの前提条件

      • BUILD - ビルドファイル。
      • METADATA - ビルド メタデータ ファイル。
      • OWNERS - API ディレクトリのオーナー。
    • 構成ファイル

      • {service}.yaml - ベースライン サービス構成ファイル。これは、google.api.Service proto メッセージの YAML 表現です。
      • prod.yaml - 本番デルタサービス構成ファイル。
      • staging.yaml - ステージング デルタサービス構成ファイル。
      • test.yaml - テスト デルタサービス構成ファイル。
      • local.yaml - ローカル デルタサービス構成ファイル。
    • ドキュメント ファイル

      • README.md - メインの readme ファイル。これには、一般的な作成概要、技術的な説明などを含めます。
      • doc/* - 技術ドキュメント ファイル。Markdown 形式にします。
    • インターフェース定義

      • v[0-9]*/* - このような各ディレクトリには、API のメジャー バージョン、主に proto ファイルとビルド スクリプトが含まれています。
      • {subapi}/v[0-9]*/* - 各 {subapi} ディレクトリには、サブ API のインターフェース定義が含まれています。各サブ API は、独自の独立したメジャー バージョンを持つことができます。
      • type/* - 異なる API 間、同じ API の異なるバージョン間、API とサービス実装の間で共有される型を含む proto ファイル。type/* の下にある型の定義には、リリースされた後は互換性が損なわれるような変更を加えないでください
このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...