Bagaimana cara mengirim permintaan gRPC di Apidog?

gRPC adalah kerangka kerja Remote Procedure Call (RPC) yang efisien, cepat, dan andal, serta banyak digunakan dalam berbagai skenario. Dalam arsitektur microservices, Apidog memfasilitasi komunikasi yang efisien antar layanan. Untuk skenario yang melibatkan transfer data dalam jumlah besar, Apidog memanfaatkan kemampuan streaming untuk mengurangi latensi jaringan dan konsumsi bandwidth.

Fungsionalitas debugging API gRPC saat ini berada dalam tahap pengujian Beta. Versi Apidog harus sama dengan atau lebih besar dari 2.3.0 untuk menggunakan fitur debugging API gRPC.

Membuat Proyek gRPC Baru

Klik tombol "New Project" di halaman beranda Apidog dan pilih "gRPC Project (Beta)."

Mengimpor Proto

gRPC mengikuti pendekatan API-First, yang berarti bahwa sebelum pengembangan, layanan, metode, dan pesan harus didefinisikan melalui file .proto. Oleh karena itu, sebelum melakukan debugging API gRPC menggunakan Apidog, Anda perlu mengimpor file .proto yang berfungsi sebagai definisi API.

Impor Awal

Saat ini, terdapat dua cara untuk mengimpor file .proto:

File lokal

URL yang menghosting file .proto

File .proto yang dipilih akan diimpor sebagai satu Proto, di mana layanan akan diimpor sebagai layanan, dan rpc akan diimpor sebagai metode.

Jika file .proto yang dipilih bergantung pada file .proto lain, Anda perlu menambahkan direktori dependensi secara manual.

Layanan dari file .proto lain yang menjadi dependensi file .proto yang dipilih juga akan diimpor ke Proto yang sama jika package-nya termasuk dalam package yang sama dengan file .proto yang dipilih.

Mengimpor Ulang

Jika file .proto yang telah diimpor mengalami perubahan, file tersebut dapat diimpor ulang di Apidog: klik kanan pada Proto, lalu klik tombol "Reimport".

Metode Pemanggilan

Saat mendefinisikan metode gRPC menggunakan file .proto, Apidog mendukung empat jenis:

Unary: Panggilan satu arah

Server Streaming: Streaming sisi server

Client Streaming: Streaming sisi klien

Bidirectional Streaming: Streaming dua arah

Apidog mendukung keempat jenis metode tersebut.

Panggilan Unary

Panggilan unary serupa dengan permintaan HTTP. Masukkan URL di bilah alamat, masukkan konten pesan dalam format JSON pada tab Message, klik tombol "Invoke", dan panggilan unary akan dimulai.

Selain itu, Anda dapat mengisi informasi Metadata dan Auth secara manual untuk memenuhi kebutuhan autentikasi atau skenario kompleks lainnya.

Panggilan Streaming

Panggilan streaming serupa dengan koneksi WebSocket. Setelah memulai panggilan, Anda dapat menulis dan mengirim pesan pada tab Message. Server streaming, client streaming, dan bidirectional streaming termasuk dalam jenis panggilan streaming.

Apidog menyediakan tampilan timeline yang menampilkan status panggilan, pesan yang dikirim, dan pesan yang diterima secara terpusat dalam urutan kronologis. Mengklik sebuah pesan memungkinkan Anda melihat detail pesan dengan mudah.

Penggunaan Lanjutan

Membuat Nilai Dinamis Secara Otomatis

Apidog dapat mengenali konten dalam file .proto, sehingga Anda dapat mengklik tombol "Auto-generate" untuk membuat body pesan. Untuk data dinamis yang lebih fleksibel, Anda dapat mengonfigurasi dan membuat ekspresi menggunakan fitur "Dynamic Values".

Lihat "Dynamic Values" untuk instruksi yang lebih terperinci.

Menggunakan Variabel

Anda dapat menggunakan variabel Apidog dalam pesan gRPC dan Metadata. Lihat dokumentasi "Environment Variable Types" untuk instruksi terperinci.

Mengaktifkan TLS

API gRPC mendukung pembuatan koneksi aman melalui TLS.

Dengan menggunakan Apidog, Anda dapat mengklik pemilih protokol di depan URL untuk beralih status TLS dengan cepat.

Selain itu, Apidog kompatibel dengan penggunaan grpcs:// dalam URL untuk mengaktifkan TLS pada koneksi. Sebaliknya, grpc:// menunjukkan bahwa TLS tidak diaktifkan.

Mengelola Alamat Server dan Lingkungan

Klik ikon plus di sisi kanan bilah alamat URL untuk menambahkan alamat server yang sedang digunakan ke suatu lingkungan.

Kemudian, pilih lingkungan dan alamat server di sudut kanan atas, lalu pilih "Follow Default" di bilah alamat URL untuk menggunakan alamat server terpadu saat melakukan debugging pada semua metode.

Melihat File Proto dan Parameter API

Melihat Konten File Proto

Di Apidog, mengklik Proto pada pohon direktori di sebelah kiri memungkinkan Anda melihat konten mentah file .proto.

Melihat Parameter Permintaan dan Respons

gRPC menggunakan ProtoBuf sebagai format serialisasi, yang berarti bahwa setiap pesan ditransmisikan dalam format ProtoBuf saat mengirim atau menerima pesan. Tidak seperti format serialisasi berbasis teks lainnya (JSON, XML), ProtoBuf adalah format biner yang tidak cocok untuk ditulis dan dibaca oleh manusia. Oleh karena itu, saat memanggil API gRPC di Apidog, semua pesan ditulis dan ditampilkan dalam format JSON.

Anda dapat melihat parameter permintaan dan respons yang direpresentasikan dalam format JSON pada halaman informasi API.

ProtoBuf dan JSON memiliki hubungan pemetaan untuk tipe data, sebagaimana ditunjukkan dalam tabel di bawah ini:

ProtoBuf 3	JSON	Contoh JSON
message	object	`{"fooBar": v, "g": null, …}`
enum	string	`"FOO_BAR"`
map<K,V>	object	`{"k": v, …}`
repeated V	array	`[v, …]`
bool	boolean	`true, false`
string	string	`"Hello World!"`
bytes	base64 string	`"YWJjMTIzIT8kKiYoKSctPUB+"`
int32, fixed32, uint32	number	`1, -10, 0`
int64, fixed64, uint64	string	`"1", "-10"`
float, double	number	`1.1, -10.0, 0, "NaN", "Infinity"`

Menyimpan Informasi Debugging

Setelah menyelesaikan debugging, klik tombol "Save" untuk menyimpan URL server, pesan, Metadata, dan sebagainya, dalam metode saat ini agar anggota tim lain dapat melakukan debugging.

Bagaimana cara mengirim permintaan gRPC di Apidog?

Membuat Proyek gRPC Baru#

Mengimpor Proto#

Impor Awal#

Mengimpor Ulang#

Metode Pemanggilan#

Panggilan Unary#

Panggilan Streaming#

Penggunaan Lanjutan#

Membuat Nilai Dinamis Secara Otomatis#

Menggunakan Variabel#

Mengaktifkan TLS#

Mengelola Alamat Server dan Lingkungan#

Melihat File Proto dan Parameter API#

Melihat Konten File Proto#

Melihat Parameter Permintaan dan Respons#

Menyimpan Informasi Debugging#

Membuat Proyek gRPC Baru

Mengimpor Proto

Impor Awal

Mengimpor Ulang

Metode Pemanggilan

Panggilan Unary

Panggilan Streaming

Penggunaan Lanjutan

Membuat Nilai Dinamis Secara Otomatis

Menggunakan Variabel

Mengaktifkan TLS

Mengelola Alamat Server dan Lingkungan

Melihat File Proto dan Parameter API

Melihat Konten File Proto

Melihat Parameter Permintaan dan Respons

Menyimpan Informasi Debugging