Bagaimana Pengguna Dokumentasi Dapat Mengubah URL Dasar dalam Dokumentasi Bersama?
Dalam dokumentasi yang dipublikasikan atau dokumentasi yang dibagikan secara cepat di Apidog, jika Anda ingin pengguna dokumentasi dapat mengatur dan mengubah URL Dasar, hal ini dapat dicapai dengan mudah melalui pengaturan variabel. Langkah-langkah operasional spesifiknya adalah sebagai berikut:
1
Buat dan referensikan variabel
Di proyek Apidog, buka halaman "Lingkungan" tertentu, klik "Tambahkan Variabel", lalu masukkan nama variabel (misalnya, "BaseURL"). Pada kotak input URL yang sesuai dengan "URL Dasar" lingkungan, gunakan referensi variabel (misalnya, {{BaseURL}}) untuk menggantikan alamat URL tertentu. Ini mengaitkan URL Dasar dengan variabel yang telah dibuat.
2
Pilih Lingkungan
Pilih lingkungan yang sesuai saat memublikasikan dokumentasi.
3
Akses dokumentasi
Setelah dokumentasi dipublikasikan dan dibagikan kepada pengguna, pengguna dapat melihat lokasi tempat variabel direferensikan pada endpoint. Saat mouse diarahkan ke referensi variabel, pengguna akan diminta untuk menetapkan nilai variabel.
4
Ubah nilai variabel
Klik variabel tersebut, dan jendela pengaturan variabel akan muncul secara otomatis. Pengguna hanya perlu mengisi nilai aktual yang diperlukan.
Setelah disimpan, path yang ditampilkan pada dokumentasi dan permintaan aktual akan secara otomatis menerapkan nilai variabel yang telah diperbarui.
Metode ini memungkinkan pengguna menyesuaikan URL Dasar untuk mengakses data spesifik mereka.