Layanan API biasanya menggunakan file .proto
untuk menentukan platform 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 pengukuran, yang merupakan representasi YAML dari pesan protogoogle.api.Service
.prod.yaml
- File konfigurasi layanan delta produksi.staging.yaml
- File konfigurasi layanan delta staging.test.yaml
- File konfigurasi layanan delta pengujian.local.yaml
- File konfigurasi layanan delta lokal.
File dokumentasi
doc/*
- File dokumentasi teknis. Tag tersebut harus dalam format Markup.
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 digunakan bersama oleh API yang berbeda, versi API yang sama berbeda, atau antara API dan implementasi layanan. Definisi jenis dalamtype/*
tidak boleh memiliki perubahan yang dapat menyebabkan gangguan setelah dirilis.
Definisi Google API publik dipublikasikan di GitHub, lihat repositori Google API. Untuk mengetahui detail struktur direktori, lihat Service Infrastructure Example API.