Pengantar
Ini adalah panduan desain umum untuk API berjaringan. API ini telah digunakan di dalam Google sejak 2014 dan merupakan panduan yang diikuti Google saat mendesain Cloud API dan Google API lainnya. Panduan desain ini dibagikan di sini untuk memberi tahu developer luar dan memudahkan kita semua bekerja sama.
Panduan ini mungkin berguna bagi developer Cloud Endpoints ketika mendesain API gRPC, dan sebaiknya developer tersebut menggunakan prinsip-prinsip desain ini. Namun, kami tidak memerintahkan penggunaannya. Anda dapat menggunakan Cloud Endpoint dan gRPC tanpa mengikuti panduan.
Panduan ini berlaku untuk REST API dan RPC API, dengan fokus khusus pada gRPC API. gRPC API menggunakan Buffering Protokol untuk menentukan platform API dan Konfigurasi Layanan API guna mengonfigurasi layanan API-nya, termasuk pemetaan, logging, dan pemantauan HTTP. Fitur pemetaan HTTP digunakan oleh Google API dan Cloud Endpoints gRPC API untuk transcoding JSON/HTTP ke Protocol Buffers/RPC.
Panduan ini merupakan dokumen dinamis dan akan terus diperbarui seiring berjalannya gaya dan pola desain baru diadopsi dan disetujui. Dengan demikian, tidak akan pernah lengkap dan akan selalu ada cukup ruang untuk seni dan kerajinan desain API.
Konvensi yang Digunakan dalam Panduan Ini
Kata kunci tingkat persyaratan "HARUS", "MUST NOT", "Required", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", dan "OPTIONAL" yang digunakan dalam dokumen ini harus ditafsirkan seperti yang dijelaskan dalam RFC 2119.
Dalam dokumen ini, kata kunci tersebut disorot menggunakan font tebal.
Rubrik
- Desain berorientasi resource
- Nama Resource
- Metode Standar
- Metode Kustom
- Kolom Standar
- Error
- Konvensi Penamaan
- Pola Desain
- Dokumentasi
- Menggunakan proto3
- Pembuatan Versi
- Kompatibilitas
- Struktur Direktori
- Struktur File
- Glosarium