• Español

      • nb api

      Invoca la API de NocoBase a través del CLI. nb api incluye los comandos CRUD genéricos nb api resource, así como comandos generados dinámicamente a partir del esquema OpenAPI de la aplicación actual.

      Uso

      nb api <command>

      Subcomandos

      ComandoDescripción
      nb api resourceEjecutar operaciones CRUD genéricas y consultas agregadas sobre cualquier recurso de NocoBase
      nb api comandos dinámicosComandos de topic y operación generados a partir del esquema OpenAPI de la aplicación

      Parámetros generales

      La mayoría de los comandos nb api admiten los siguientes parámetros de conexión:

      ParámetroTipoDescripción
      --api-base-urlstringDirección de la API de NocoBase, por ejemplo http://localhost:13000/api
      --env, -estringNombre del entorno
      --token, -tstringSobrescritura de la API key
      --rolestringSobrescritura del rol; se envía como cabecera X-Role
      --verbosebooleanMostrar el progreso detallado
      --json-output, -j / --no-json-outputbooleanSi devolver JSON sin procesar; activado por defecto

      Ejemplos

      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

      Comandos relacionados