• Français

      • nb api

      Appeler l'API NocoBase via le CLI. nb api regroupe les commandes CRUD génériques nb api resource ainsi que les commandes générées dynamiquement à partir du schéma OpenAPI de l'application courante.

      Utilisation

      nb api <command>

      Sous-commandes

      CommandeDescription
      nb api resourceExécuter des opérations CRUD génériques et des requêtes d'agrégation sur n'importe quelle ressource NocoBase
      nb api commandes dynamiquesCommandes par topic et opération générées à partir du schéma OpenAPI de l'application

      Paramètres communs

      La plupart des commandes nb api acceptent les paramètres de connexion suivants :

      ParamètreTypeDescription
      --api-base-urlstringAdresse de l'API NocoBase, par exemple http://localhost:13000/api
      --env, -estringNom de l'environnement
      --token, -tstringSubstitution de l'API key
      --rolestringSubstitution du rôle, envoyée dans l'en-tête X-Role
      --verbosebooleanAfficher la progression détaillée
      --json-output, -j / --no-json-outputbooleanRenvoyer le JSON brut, activé par défaut

      Exemples

      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

      Commandes connexes