Custom Protocol API digunakan untuk mengelola API dengan protokol kustom.Dengan fitur ini, Anda dapat membuat dan memelihara dokumentasi API untuk berbagai jenis protokol (seperti Thrift, UDP, Kafka, RabbitMQ, RocketMQ, dan sebagainya) secara terpadu, semuanya dikelola secara terpusat di dalam Apidog.Sama seperti dokumentasi HTTP API, dokumentasi API protokol kustom juga mendukung pohon folder, opsi pencarian dan filter, pengelolaan massal, serta berbagi secara online — sehingga memudahkan tim untuk berkolaborasi dan berbagi secara eksternal.Membuat Custom Protocol API#
1
Di atas pohon folder, arahkan kursor ke ikon
+, lalu pilih
New Other Protocol APIs dan klik
Other Custom Protocol API.
2
Pilih jenis protokol (opsi mencakup Thrift, Kafka, dan sebagainya, atau klik
Manage Protocol untuk menambahkan protokol kustom).
Tersedia templat default untuk setiap protokol.3
Isi detail berikut:
URI: ID unik untuk endpoint, digunakan untuk membedakannya dari endpoint lain (mirip dengan path URL untuk endpoint HTTP).
Endpoint Name: Nama endpoint.
Basic Information: Status, pengelola, tag, dan detail lainnya.
Documentation Details: Memungkinkan pengeditan deskripsi, instruksi penggunaan, contoh, dan lainnya secara lebih fleksibel.
4
Setelah menyimpan, Anda akan melihat dokumentasi endpoint untuk protokol yang dipilih telah dibuat.
Membagikan Dokumentasi Custom Protocol API#
Dokumentasi API protokol kustom juga mendukung berbagi secara online, sehingga memudahkan kolaborasi dan presentasi eksternal.Anda dapat menyalin tautan kolaborasi untuk dibagikan di dalam proyek.Anda juga dapat membuka Publish Docs > Quick Share, memilih endpoint yang akan disertakan, dan menentukan apakah akan membagikan dokumentasi API protokol kustom. Modified at 2026-06-11 10:17:04