• Русский

      • Динамические команды nb api

      Помимо nb api resource, под nb api имеется набор команд, динамически генерируемых на основе OpenAPI Schema приложения NocoBase. Эти команды создаются и кэшируются при первом запуске nb env add или nb env update.

      Распространённые группы

      Группа командОписание
      nb api aclКонтроль доступа: роли, права на ресурсы и права действий
      nb api api-keysУправление ключами API
      nb api appУправление приложением
      nb api authenticatorsУправление аутентификацией: пароль, SMS, SSO и др.
      nb api data-modelingМоделирование данных: источники данных, коллекции и поля
      nb api file-managerУправление файлами: сервисы хранения и вложения
      nb api flow-surfacesОркестрация страниц: страницы, блоки, поля и действия
      nb api system-settingsСистемные настройки: заголовок, логотип, язык и др.
      nb api theme-editorУправление темами: цвета, размеры и переключение тем
      nb api workflowРабочий процесс: управление автоматизированными процессами

      Реальные доступные группы и команды зависят от версии подключённого приложения NocoBase и включённых плагинов. Запустите следующие команды, чтобы посмотреть, какие команды поддерживает текущее приложение:

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

      Параметры тела запроса

      Динамические команды с телом запроса поддерживают:

      ПараметрТипОписание
      --bodystringТело запроса в виде строки JSON
      --body-filestringПуть к файлу JSON

      Параметры --body и --body-file взаимоисключающие.

      Динамические команды API также поддерживают:

      • --env, -e: имя CLI-окружения, в которое отправляется запрос; если параметр не указан, используется текущее окружение
      • --yes, -y: если явно переданный --env указывает на окружение, отличное от текущего, пропускает интерактивное подтверждение

      Если вы явно передаёте --env, и оно отличается от текущего окружения, CLI сначала запросит подтверждение. В неинтерактивных терминалах или сессиях ИИ-агента добавьте --yes самостоятельно либо сначала выполните nb env use <name>, а затем повторите попытку.

      Связанные команды