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.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-11 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-11 UTC."],[[["\u003cp\u003eAPI services utilize \u003ccode\u003e.proto\u003c/code\u003e files for API definition and \u003ccode\u003e.yaml\u003c/code\u003e files for service configuration.\u003c/p\u003e\n"],["\u003cp\u003eEach API service must reside in an API directory within an API repository, containing all definition files and build scripts.\u003c/p\u003e\n"],["\u003cp\u003eAn API directory should follow a standard layout including repository prerequisites, configuration files, documentation files, and interface definitions, like versioned sub-API directories, and type files for shared proto files.\u003c/p\u003e\n"],["\u003cp\u003ePublic Google API definitions are available on the \u003ca href=\"https://github.com/googleapis/googleapis\"\u003eGoogle APIs\u003c/a\u003e GitHub repository, as seen with the \u003ca href=\"https://github.com/googleapis/googleapis/tree/master/google/example/endpointsapis\"\u003eService Infrastructure Example API\u003c/a\u003e.\u003c/p\u003e\n"]]],[],null,[]]
