Modul

Dalam proyek Apidog, Anda dapat menggunakan modul untuk mengatur endpoint Anda. Modul mirip dengan "layanan" dalam arsitektur teknis, yang dirancang untuk membantu Anda mengelola dan menyajikan endpoint secara lebih efisien — terutama dalam sistem berbasis microservice. Setiap modul mencakup kumpulan endpoint terkait, komponen (seperti skema, respons, dan skema keamanan), serta Base URL-nya sendiri (satu untuk setiap lingkungan).

Setiap modul berkaitan dengan satu file spesifikasi Swagger/OpenAPI yang lengkap dan independen.

Kapan Menggunakan Modul

Gunakan modul untuk mengatur endpoint Anda ketika:

Layanan yang sangat terkait: Misalnya, dalam proyek AI: satu modul untuk endpoint pembuatan teks, modul lain untuk endpoint pembuatan gambar, dan satu modul untuk endpoint suara.

Microservices: Misalnya, dalam proyek e-commerce, Anda mungkin memiliki layanan autentikasi, pesanan, dan produk.

Beberapa versi API: Misalnya, proyek Anda mengekspos berbagai versi API kepada pengguna eksternal, seperti Legacy, LTS, dan Latest.

Membuat Modul

Dalam proyek, arahkan kursor ke bagian atas pohon folder dan klik tombol +. Dalam menu dropdown, pilih New Module.

Masukkan nama modul dan klik Save. Modul baru akan muncul di pohon folder. Klik modul tersebut untuk melihat detailnya, termasuk:

Statistik data sumber daya dalam modul

Cakupan kasus endpoint dan skenario pengujian

Opsi ekspor untuk endpoint dalam modul

Pengaturan sumber data

Variabel modul – mirip dengan variabel lingkungan, tetapi hanya dapat diakses dalam permintaan endpoint modul ini.

Mengatur Base URL untuk Setiap Modul

Setelah modul dibuat, modul tersebut akan otomatis muncul di halaman Manajemen Lingkungan. Anda dapat menetapkan Base URL untuk setiap lingkungan dalam modul yang baru ditambahkan.

Mengatur Base URL modul dalam manajemen lingkungan

Menggunakan Base URL yang Benar Saat Membuat Permintaan

Secara default, permintaan endpoint setiap modul akan secara otomatis menggunakan Base URL yang ditentukan untuk modul tersebut dalam lingkungan saat ini, digabungkan dengan path endpoint. Endpoint dari satu modul tidak dapat menggunakan Base URL modul lain untuk mengirim permintaan.

Penggunaan Base URL otomatis dalam permintaan

Pola Penggunaan Legacy

Jika satu modul berisi beberapa layanan (beberapa Base URL), Anda dapat menentukan secara manual Base URL mana yang akan digunakan pada tingkat folder atau endpoint dalam modul tersebut.

Namun, pendekatan ini merupakan bagian dari pola penggunaan lama di Apidog dan tidak direkomendasikan sejak versi 2.7.16. Sebagai gantinya, kami menyarankan untuk memisahkan layanan ke dalam modul terpisah, masing-masing dengan Base URL-nya sendiri.

Pelajari lebih lanjut: Lingkungan & layanan

Kapan Menggunakan Modul#

Membuat Modul#

Mengatur Base URL untuk Setiap Modul#

Menggunakan Base URL yang Benar Saat Membuat Permintaan#

Kapan Menggunakan Modul

Membuat Modul

Mengatur Base URL untuk Setiap Modul

Menggunakan Base URL yang Benar Saat Membuat Permintaan