Cara Berbagi Pengaturan Koneksi Database dengan Tim di Apidog

Sebagai alat kolaboratif untuk desain API, dokumentasi, debugging, mocking, dan pengujian, Apidog memiliki fitur yang sangat dipuji: mendukung operasi basis data saat mengirim/menerima permintaan. Fitur ini sangat memfasilitasi pengguna yang perlu menyiapkan data permintaan saat memanggil endpoint atau memasukkan data ke dalam basis data setelah menerima respons, menjadikannya favorit di kalangan pengguna.

Namun, karena banyak pengguna memanfaatkan fitur ini secara ekstensif setiap hari, beberapa area untuk perbaikan telah diidentifikasi. Salah satu poin yang paling sering diangkat adalah:

Bisakah konfigurasi koneksi basis data diatur oleh admin tim dan kemudian digunakan secara kolaboratif oleh anggota tim lainnya? Sangat merepotkan bagi setiap orang untuk memasukkan detail koneksi kembali.

Dari desain awal fitur ini, kami telah mempertimbangkan apakah akan mengizinkan konfigurasi basis data untuk digunakan secara kolaboratif. Namun, mengizinkan pengguna untuk menyimpan informasi sensitif seperti nama pengguna dan kata sandi basis data di server cloud adalah masalah yang memerlukan pertimbangan cermat. Oleh karena itu, keamanan data adalah alasan utama mengapa penggunaan kolaboratif konfigurasi koneksi basis data tidak diterapkan pada saat itu.

Hari ini, Apidog telah menjadi alat kolaborasi dan manajemen API utama bagi jutaan pengembang, dan kemampuan dasar Apidog sendiri telah menjadi lebih kuat. Oleh karena itu, kami telah mempertimbangkan kembali persyaratan optimasi ini untuk penggunaan kolaborasi konfigurasi koneksi basis data, berusaha menyeimbangkan keamanan data dan efisiensi pengembangan untuk memuaskan pengguna kami.

Menyimpan Konfigurasi Koneksi Basis Data di Cloud

Langkah 1: Buat Koneksi Basis Data Baru

Ketika versi Apidog Anda diperbarui ke 2.6.50 atau di atasnya, buka "Pengaturan Proyek -> Koneksi Basis Data" dan klik untuk membuat koneksi basis data baru. Anda akan menemukan bahwa semua bidang koneksi memandu Anda untuk menggunakan variabel untuk mengisi nilai bidang.

Langkah 2: Atur Variabel di Lingkungan Berbeda

Dalam manajemen lingkungan, atur variabel untuk koneksi basis data yang akan digunakan di lingkungan berbeda. Dengan cara ini, variabel-variabel ini dapat diterapkan dalam konfigurasi koneksi basis data.

Langkah 3: Konfigurasi Koneksi Basis Data Menggunakan Variabel

Kembali ke halaman konfigurasi koneksi basis data, Anda dapat secara manual mengisi variabel menggunakan format variabel, atau langsung mereferensikan variabel-variabel ini melalui fitur nilai dinamis. Kami merekomendasikan penggunaan variabel lingkungan di sini agar konfigurasi secara otomatis beralih dengan konteks lingkungan yang berbeda. Kecuali untuk nomor port, semua bidang lainnya sebaiknya diisi menggunakan variabel.

Langkah 4: Simpan dan Gunakan Koneksi Basis Data

Simpan konfigurasi koneksi basis data yang menggunakan variabel, dan itu dapat digunakan dalam operasi basis data di manajemen API, pengujian otomatis, dan area lainnya.

Saat digunakan, mekanisme penggunaan aktual untuk konfigurasi koneksi basis data yang disimpan secara lokal versus yang disimpan di cloud adalah sebagai berikut:

PRO TIP: Untuk anggota proyek lain yang perlu menggunakan konfigurasi koneksi basis data ini, mereka sekarang hanya perlu pergi ke manajemen lingkungan, menemukan variabel yang sesuai dan mengisi nilai lokal, tanpa harus mengkonfigurasi di manajemen proyek seperti sebelumnya.

Ini adalah langkah-langkah terperinci untuk mengkonfigurasi koneksi basis data cloud. Karena penggunaan nilai lokal direkomendasikan, dan konfigurasi aktual masih disimpan secara lokal, jadi tidak perlu khawatir tentang risiko keamanan data. Variabel hanya membuat proses lebih nyaman dan mudah dikelola.

Apidog juga terus mendukung pemasukan nilai aktual secara langsung ke dalam pengaturan koneksi basis data. Ini memastikan kompatibilitas dengan konfigurasi yang ada dan mendukung pengguna yang lebih suka bekerja dengan data lokal. Namun, pengingat yang jelas akan ditampilkan, mendorong pengguna untuk beralih ke variabel dan menyimpannya ke cloud untuk pengalaman yang lebih baik dan lebih efisien.

Perhatian untuk Menggunakan Koneksi Basis Data Cloud:

Dalam konfigurasi koneksi basis data, ketika variabel digunakan, yang sebenarnya disimpan di cloud adalah nama variabel. Saat mengeksekusi koneksi basis data, konfigurasi koneksi lengkap akan dirakit sesuai dengan aturan penggunaan variabel untuk memulai koneksi.

✅ Tindakan yang Direkomendasikan:

• Gunakan "Current Value" atau "Vault Variable" untuk nilai variabel.
• Nomor port dapat dimasukkan langsung, tidak perlu menggunakan variabel, demi kenyamanan & tanpa risiko.

❌ Tindakan yang Tidak Direkomendasikan:

• Menggunakan "Initial Value" untuk nilai variabel.
• Mencampur plaintext dan variabel, yang masih mengharuskan setiap orang untuk mengkonfigurasi secara terpisah di pengaturan proyek.

Menggunakan Variabel Vault untuk Menyimpan Konfigurasi Koneksi Basis Data

Untuk pengaturan koneksi basis data, kami merekomendasikan penggunaan variabel Vault. Variabel-variabel ini diambil dari layanan manajemen rahasia eksternal dan disimpan dalam bentuk terenkripsi di mesin lokal Anda. Pendekatan ini menawarkan yang terbaik dari kedua dunia—perlindungan data yang aman dan kolaborasi tim yang efisien melalui penyimpanan cloud.

Langkah 1: Konfigurasi Variabel Vault

Siapkan penyedia Vault dan simpan plaintext kredensial koneksi basis data di dalamnya. Untuk konfigurasi koneksi basis data di lingkungan yang berbeda, Anda perlu membuat Kunci Vault yang berbeda di penyedia Anda. Untuk metode spesifik, lihat dokumentasi bantuan.

Langkah 2: Buat Variabel Lingkungan

Untuk setiap lingkungan, buat variabel lingkungan dengan nama yang sama—seperti dbHost. Kemudian, atur Initial Value untuk mereferensikan variabel Vault yang sesuai untuk lingkungan tersebut, dan biarkan Current Value mengikuti nilai awal.

Mengapa melakukan ini?

1. Ini membungkus variabel Vault dalam variabel lingkungan. Jadi, saat Anda mengkonfigurasi koneksi basis data nanti, Anda hanya perlu memilih variabel lingkungan. Apidog akan secara otomatis menggunakan nilai yang benar berdasarkan lingkungan saat ini.
2. Menyimpan data dalam nilai awal memastikan semua anggota proyek dapat menggunakannya tanpa perlu mengaturnya secara manual lagi—meningkatkan efisiensi tim.

Langkah 3: Atur Koneksi Basis Data Menggunakan Rahasia Vault

Saat mengatur koneksi basis data, gunakan variabel lingkungan yang telah Anda definisikan di Environment Management (misalnya, dbHost, dbUser, dbPassword). Untuk mereferensikan variabel-variabel ini dengan cepat, gunakan fitur nilai dinamis.

Langkah 4: Uji Koneksi Basis Data

Klik "Uji Koneksi". Anda akan diminta untuk memilih lingkungan untuk pengujian.

Pastikan variabel yang digunakan dalam koneksi (seperti host, port, nama pengguna, dll.) dikonfigurasi dengan benar untuk lingkungan tersebut. Setelah dikonfirmasi, sistem akan menguji koneksi:

• ✅ Jika berhasil, Anda siap.
• ❌ Jika gagal, periksa pesan kesalahan untuk langkah-langkah pemecahan masalah spesifik.

Langkah 5: Gunakan Operasi Basis Data dalam Permintaan Endpoint

Dalam Pre Processors atau Post Processors dari permintaan endpoint, Anda dapat menambahkan operasi basis data menggunakan konfigurasi basis data cloud yang disimpan.

Contoh:

Misalnya Anda ingin:

1. Mencari id hewan peliharaan bernama "Nancy" dari basis data.
2. Menggunakan ID tersebut untuk mengambil info detail melalui permintaan endpoint.

Apidog kemudian akan:

• Mengeksekusi operasi basis data
• Mengambil nilai (misalnya, petID)
• Menyimpannya sebagai variabel (misalnya, petId)
• Menggunakan variabel tersebut dalam permintaan endpoint

Setelah konfigurasi basis data diatur di cloud seperti yang dijelaskan di atas:

• Anggota tim lain dapat menggunakannya kembali dalam operasi basis data mereka sendiri.
• Tidak perlu setiap orang mengkonfigurasinya secara manual.
• Menghemat waktu dan memastikan konsistensi di seluruh proyek Anda.

Kesimpulan Akhir

Praktik di atas menunjukkan cara menggunakan variabel Vault untuk menyimpan dan menerapkan konfigurasi koneksi basis data dengan aman. Berikut adalah ringkasan singkat langkah-langkahnya:

• Buat variabel Vault terpisah untuk setiap pengaturan basis data di lingkungan yang berbeda (misalnya, testDBHost untuk pengujian, prodDBHost untuk produksi). Anda dapat melewati port karena biasanya tetap sama.
• Definisikan variabel lingkungan dengan nama yang sama di semua lingkungan. Untuk setiap lingkungan, atur nilai awal variabel lingkungan untuk mereferensikan variabel Vault yang sesuai.

Tabel di bawah ini mengilustrasikan cara mengatur variabel lingkungan ini untuk pengujian dan produksi. Anda dapat mengatur nilai saat ini agar sesuai dengan nilai awal.