Struktur direktori

Layanan API biasanya menggunakan file .proto untuk menentukan permukaan API dan file .yaml untuk mengonfigurasi layanan API. Setiap layanan API harus memiliki direktori API di dalam repositori API. Direktori API harus berisi semua file definisi API dan skrip build.

Setiap direktori API harus memiliki tata letak standar berikut:

• Direktori API

  • Prasyarat repositori

    • BUILD - File build.
    • METADATA - File metadata build.
    • OWNERS - Pemilik direktori API.
    • README.md - Informasi umum tentang layanan API.

  • File konfigurasi

    • {service}.yaml - File konfigurasi layanan dasar, yang merupakan representasi YAML dari pesan proto google.api.Service.
    • prod.yaml - File konfigurasi layanan delta prod.
    • staging.yaml - File konfigurasi layanan delta penyiapan.
    • test.yaml - File konfigurasi layanan delta pengujian.
    • local.yaml - File konfigurasi layanan delta lokal.

  • File dokumentasi

    • doc/* - File dokumentasi teknis. Harus dalam format Markdown.

  • Definisi antarmuka

    • v[0-9]*/* - Setiap direktori tersebut berisi versi utama API, terutama file proto dan skrip build.
    • {subapi}/v[0-9]*/* - Setiap direktori {subapi} berisi definisi antarmuka sub-API. Setiap sub-API dapat memiliki versi utama independennya sendiri.
    • type/* - file proto yang berisi jenis yang dibagikan di antara API yang berbeda, versi API yang sama, atau antara API dan implementasi layanan. Definisi jenis di bagian type/* seharusnya tidak memiliki perubahan yang dapat menyebabkan gangguan setelah dirilis.

Definisi Google API publik dipublikasikan di GitHub, lihat repositori Google APIs.