nb api

Gọi NocoBase API thông qua CLI. nb api bao gồm các lệnh CRUD chung nb api resource, cũng như các lệnh được sinh động dựa trên OpenAPI Schema của ứng dụng hiện tại.

Cách dùng

nb api <command>

Lệnh con

LệnhMô tả
nb api resourceThực hiện CRUD và truy vấn tổng hợp trên bất kỳ tài nguyên NocoBase nào
nb api Lệnh độngLệnh topic và operation được sinh từ OpenAPI Schema của ứng dụng

Tham số chung

Hầu hết các lệnh nb api đều hỗ trợ các tham số kết nối sau:

Tham sốKiểuMô tả
--api-base-urlstringĐịa chỉ API NocoBase, ví dụ http://localhost:13000/api
--env, -estringTên môi trường
--token, -tstringGhi đè API key
--rolestringGhi đè role, gửi đi qua header X-Role
--verbosebooleanHiển thị tiến trình chi tiết
--json-output, -j / --no-json-outputbooleanCó output JSON gốc hay không, mặc định bật

Ví dụ

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

Lệnh liên quan