• Tiếng Việt

      • nb api Lệnh động

      Bên cạnh nb api resource, trong nb api còn có một nhóm lệnh được sinh động từ OpenAPI Schema của ứng dụng NocoBase. Các lệnh này được sinh và cache lần đầu khi bạn chạy nb env add hoặc nb env update.

      Các nhóm lệnh phổ biến

      Nhóm lệnhMô tả
      nb api aclQuản lý quyền: role, quyền tài nguyên và quyền thao tác
      nb api api-keysQuản lý API Key
      nb api appQuản lý ứng dụng
      nb api authenticatorsQuản lý xác thực: mật khẩu, SMS, SSO,...
      nb api data-modelingMô hình dữ liệu: data source, bảng và field
      nb api file-managerQuản lý file: storage và attachment
      nb api flow-surfacesBố cục trang: page, block, field và action
      nb api system-settingsCài đặt hệ thống: tiêu đề, Logo, ngôn ngữ,...
      nb api theme-editorQuản lý theme: màu sắc, kích thước và chuyển đổi theme
      nb api workflowWorkflow: quản lý quy trình tự động hóa

      Các nhóm và lệnh khả dụng thực tế phụ thuộc vào phiên bản ứng dụng NocoBase và các plugin đã bật. Chạy lệnh dưới đây để xem các lệnh ứng dụng hiện đang hỗ trợ:

      nb api --help
nb api <topic> --help

      Tham số request body

      Lệnh động có request body hỗ trợ:

      Tham sốKiểuMô tả
      --bodystringRequest body dạng chuỗi JSON
      --body-filestringĐường dẫn tới file JSON

      --body và --body-file loại trừ lẫn nhau.

      Các lệnh API động cũng hỗ trợ:

      • --env, -e: tên env CLI để gửi yêu cầu tới; nếu bỏ qua thì env hiện tại sẽ được dùng
      • --yes, -y: khi --env được truyền tường minh và trỏ tới env khác với env hiện tại, bỏ qua bước xác nhận tương tác

      Nếu bạn truyền --env một cách tường minh và nó khác env hiện tại, CLI sẽ yêu cầu xác nhận trước. Trong terminal không tương tác hoặc phiên AI agent, hãy tự thêm --yes hoặc chạy nb env use <name> trước rồi thử lại.

      Lệnh liên quan