• Deutsch

      • nb api

      NocoBase-API über die CLI aufrufen. nb api enthält die generischen CRUD-Befehle nb api resource sowie Befehle, die dynamisch anhand des OpenAPI-Schemas der aktuellen Anwendung generiert werden.

      Verwendung

      nb api <command>

      Unterbefehle

      BefehlBeschreibung
      nb api resourceGenerisches CRUD und Aggregationsabfragen für beliebige NocoBase-Ressourcen ausführen
      nb api Dynamische BefehleTopic- und Operation-Befehle, die anhand des OpenAPI-Schemas der Anwendung generiert werden

      Allgemeine Parameter

      Die meisten nb api-Befehle unterstützen folgende Verbindungsparameter:

      ParameterTypBeschreibung
      --api-base-urlstringNocoBase-API-Adresse, z. B. http://localhost:13000/api
      --env, -estringUmgebungsname
      --token, -tstringAPI-key-Override
      --rolestringRollen-Override, wird als X-Role-Header gesendet
      --verbosebooleanDetaillierten Fortschritt anzeigen
      --json-output, -j / --no-json-outputbooleanOb rohes JSON ausgegeben wird, standardmäßig aktiviert

      Beispiele

      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

      Verwandte Befehle