nb api

Memanggil API NocoBase melalui CLI. nb api mencakup perintah CRUD umum nb api resource, serta perintah yang dihasilkan secara dinamis berdasarkan OpenAPI Schema dari aplikasi saat ini.

Penggunaan

nb api <command>

Subcommand

PerintahPenjelasan
nb api resourceMenjalankan CRUD umum dan agregasi query pada resource NocoBase apapun
nb api perintah dinamisPerintah topic dan operation yang dihasilkan dari OpenAPI Schema aplikasi

Parameter Umum

Sebagian besar perintah nb api mendukung parameter koneksi berikut:

ParameterTipePenjelasan
--api-base-urlstringAlamat API NocoBase, misalnya http://localhost:13000/api
--env, -estringNama lingkungan
--token, -tstringOverride API key
--rolestringOverride role, dikirim sebagai header X-Role
--verbosebooleanMenampilkan progress detail
--json-output, -j / --no-json-outputbooleanApakah menampilkan output JSON mentah, default aktif

Contoh

nb api resource list --resource users -e app1
nb api resource get --resource users --filter-by-tk 1 -e app1
nb api resource create --resource users --values '{"nickname":"Ada"}' -e app1
nb api resource list --resource users -e app1 --no-json-output

Perintah Terkait