Skip to main content

Parameter Umum

tip

Mengisi deskripsi parameter bisa menjadi tugas yang membosankan, terutama ketika banyak interface memiliki parameter dengan nama dan arti yang sama. Memasukkan deskripsi secara manual setiap kali memakan waktu dan tidak efisien. Perpustakaan deskripsi parameter menawarkan solusi untuk masalah ini.

image.png

Cara Menggunakan Perpustakaan Deskripsi Parameter​

Anda dapat mendefinisikan terlebih dahulu deskripsi parameter umum di perpustakaan deskripsi parameter. Misalnya, parameter umum meliputi:

{
    "name": "Nama pengguna",
    "age": "Umur pengguna",
    "email": "Email pengguna, biasanya digunakan untuk login",
    "school": "Sekolah pengguna"
}

image.png

Ketika nama parameter yang telah didefinisikan digunakan, deskripsi yang sesuai akan otomatis terisi, sehingga tidak perlu lagi memasukkan secara manual. Jika terdapat beberapa deskripsi untuk parameter yang sama, Anda dapat memilih salah satu dari menu dropdown.

image.png

Sistem juga mencakup kumpulan deskripsi parameter bawaan yang dapat diaktifkan dengan mudah melalui toggle.

image.png

Pemeliharaan Perpustakaan Deskripsi Parameter​

Untuk meningkatkan efisiensi pengembangan, ada dua cara untuk memelihara perpustakaan deskripsi parameter:

Ekstraksi Otomatis Deskripsi​

Selama desain atau debugging interface sehari-hari, deskripsi parameter yang dimasukkan akan secara otomatis diekstraksi dan disimpan sementara di perpustakaan deskripsi parameter.
Data yang disimpan sementara akan hilang jika halaman diperbarui. Pastikan untuk mengklik Simpan agar data tersimpan secara permanen.

image.png

image.png

Mengimpor Deskripsi Parameter​

tip

Untuk format Key-Value, gunakan titik dua (:) untuk memisahkan kunci dan nilai (contoh: name: John Doe) dan gunakan baris baru untuk memisahkan beberapa entri.

Untuk format Raw-JSON, gunakan sintaks JSON standar, misalnya: {"name": "John Doe", "age": 1}

// Contoh format key-value
name: Nama pengguna
age: Umur pengguna
email: Email pengguna
school: Sekolah
// Contoh format raw-json
{
    "name": "Nama pengguna",
    "age": "Umur pengguna",
    "email": "Email pengguna",
    "school": "Sekolah"
}

image.png