• 日本語

      • nb api

      CLI から NocoBase API を呼び出します。nb api には汎用の nb api resource CRUD コマンドと、現在のアプリケーションの OpenAPI Schema から動的に生成されるコマンドが含まれます。

      使い方

      nb api <command>

      サブコマンド

      コマンド説明
      nb api resource任意の NocoBase リソースに対して汎用 CRUD および集計クエリを実行します
      nb api ダイナミックコマンドアプリケーションの OpenAPI Schema から生成される topic および operation コマンド

      共通パラメータ

      ほとんどの nb api コマンドは以下の接続パラメータをサポートしています：

      パラメータ型説明
      --api-base-urlstringNocoBase API アドレス（例：http://localhost:13000/api）
      --env, -estring環境名
      --token, -tstringAPI key のオーバーライド
      --rolestringロールのオーバーライド。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

      関連コマンド