Parameter Umum
Mengisi parameter adalah salah satu pekerjaan yang paling merepotkan bagi kami, terutama untuk banyak API yang sering memiliki banyak parameter dengan nama dan makna yang sama. Jika harus memasukkannya secara manual setiap kali, akan sangat memakan waktu dan tidak efisien. Kami bisa menyelesaikan masalah ini melalui Parameter Umum.
Catatan: Sejak versi 2.0.22, Parameter Umum telah ditingkatkan menjadi Kamus Data (Data Dictionary), yang mendukung pengelolaan terpadu dan standar untuk bidang seperti tipe parameter, nilai default, dan deskripsi parameter. Kamu juga bisa dengan cepat memilih dan menggunakannya saat pengisian.
Cara Menggunakan Kamus Data
Kita dapat mengisi sebelumnya deskripsi parameter umum, nilai default, tipe, nilai contoh, nilai enumerasi, dan informasi lainnya di Kamus Data, yang mendukung impor cepat dengan format key-value, raw-json, dan MysqlDDL.
//key-value, Format: Key:Description
role: Peran pengguna
name: Nama pengguna
age: Usia pengguna
//raw-json, Format: {"Key":"Description"}
{"role": "Peran pengguna",
"name": "Nama pengguna",
"age": "Usia pengguna"}
Dimanapun kamu perlu memasukkan nama parameter, kamu dapat dengan cepat memilih dari dropdown. Mendukung pencarian berdasarkan kata kunci atau nama catatan langsung di kotak input. Setelah memilih parameter, nilai dan deskripsi parameter yang sudah didefinisikan sebelumnya akan terisi otomatis, sehingga tidak perlu lagi mengisi secara manual.
Selain itu, kami juga menyediakan sekumpulan parameter umum bawaan dalam sistem, yang dapat kamu aktifkan hanya dengan menggeser tombol.
Cara Memelihara
Untuk meningkatkan efisiensi pengembangan, kami menyediakan tiga cara untuk memelihara kamus data.
Menambahkan Entri Kamus Data Baru
Klik "Tambah Baru" di halaman kamus data untuk menambahkan entri parameter umum dalam jendela popup.
Catatan: Jika nama parameter duplikat, kamu dapat menggunakan nama catatan untuk membedakannya, dan kamu juga dapat mencari dengan nama catatan.
Ekstraksi Deskripsi Otomatis
Saat mendesain atau debugging API, semua deskripsi parameter yang kamu isi akan otomatis diekstrak ke dalam kamus data dan disimpan dalam status sementara.
Data yang disimpan sementara akan hilang saat memuat ulang halaman. Kamu harus mengklik simpan agar menjadi permanen.
Saat parameter baru yang kamu masukkan tidak ada di kamus data, tombol Simpan Parameter akan muncul untuk menyimpannya dengan cepat.
Impor Data
Dukungan impor cepat lewat format key-value, raw-json, dan MysqlDDL:
//key-value, Format: Key:Description
role: Peran pengguna
name: Nama pengguna
age: Usia pengguna
//raw-json, Format: {"Key":"Description"}
{"role": "Peran pengguna",
"name": "Nama pengguna",
"age": "Usia pengguna"}