• Русский

      • nb api

      Вызов API NocoBase через CLI. nb api содержит универсальные команды CRUD nb api resource, а также команды, динамически генерируемые на основе OpenAPI Schema текущего приложения.

      Использование

      nb api <command>

      Подкоманды

      КомандаОписание
      nb api resourceВыполнение универсальных CRUD-операций и агрегатных запросов на любых ресурсах NocoBase
      nb api Динамические командыКоманды topic и operation, генерируемые на основе OpenAPI Schema приложения

      Общие параметры

      Большинство команд nb api поддерживают следующие параметры подключения:

      ПараметрТипОписание
      --api-base-urlstringАдрес API NocoBase, например http://localhost:13000/api
      --env, -estringИмя окружения
      --token, -tstringПереопределение API key
      --rolestringПереопределение роли, отправляется как HTTP-заголовок X-Role
      --verbosebooleanПоказать подробный прогресс
      --json-output, -j / --no-json-outputbooleanВыводить ли исходный JSON, по умолчанию включено

      Примеры

      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

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