• Português

      • nb api

      Chamar a API do NocoBase via CLI. O nb api inclui os comandos CRUD genéricos de nb api resource e também comandos gerados dinamicamente a partir do OpenAPI Schema da aplicação atual.

      Uso

      nb api <command>

      Subcomandos

      ComandoDescrição
      nb api resourceExecuta CRUD genérico e consultas de agregação em qualquer recurso do NocoBase
      nb api comandos dinâmicosComandos de topic e operation gerados a partir do OpenAPI Schema da aplicação

      Parâmetros gerais

      A maioria dos comandos nb api aceita os seguintes parâmetros de conexão:

      ParâmetroTipoDescrição
      --api-base-urlstringEndereço da API do NocoBase, por exemplo http://localhost:13000/api
      --env, -estringNome do ambiente
      --token, -tstringSobrescrita da API key
      --rolestringSobrescrita do papel, enviada no cabeçalho X-Role
      --verbosebooleanExibe progresso detalhado
      --json-output, -j / --no-json-outputbooleanDefine se a saída JSON crua será exibida; habilitado por padrão

      Exemplos

      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