コンテンツを安全に操作する

mcms-cliでmicroCMSのコンテンツを取得・作成・更新・削除する手順を説明します。接続先の確認、APIスキーマの取得、payload検証、dry-run、本実行、反映確認を順に進め、単件操作・一括操作・インポートを安全に扱うためのコマンド例と判定方法をまとめます。

コンテンツの書き込みでは、接続先の確認、スキーマ取得、payload検証、dry-run、本実行、反映確認の順に進めます。

接続先を確認する

作業を始める前に、auth statusとconfig doctorで選択中のプロファイル、service domain、認証情報の取得元を確認します。

microcms auth status --json
microcms config doctor --json

validateと書き込みコマンドのdry-runを実行した直後は、それぞれ終了コードが0で、JSONの.okがtrueであることを確認します。

一覧と詳細を取得する

読み取り操作でも--jsonを付けると、後続処理を安定して分岐できます。

microcms content list blogs --all --json
microcms content get blogs <content-id> --json

作成前に検証する

まず最新スキーマを取得し、payloadを検証します。

microcms schema pull \
  --out microcms-schema.json \
  --json

microcms validate blogs \
  --file payload.json \
  --json

検証結果の終了コードが0で、JSONの.okがtrueであることを確認します。

dry-runしてから作成する

microcms content create blogs \
  --file payload.json \
  --dry-run \
  --json

microcms content create blogs \
  --file payload.json \
  --json

更新と削除も、同じようにdry-runを先に実行します。

microcms content update blogs <content-id> \
  --file payload.json \
  --dry-run \
  --json

microcms content delete blogs <content-id> \
  --dry-run \
  --json

複数操作をまとめる

bulkでは、操作定義と各payloadをまとめて検証できます。

microcms content bulk \
  --file operations.json \
  --validate-payload \
  --strict-warnings \
  --dry-run \
  --json

問題がなければ、--dry-runだけを外して実行します。結果のdata.failedが0であることも確認してください。

安全な自動判定

result=$(microcms validate blogs --file payload.json --json)
status=$?

if [ "$status" -ne 0 ] || \
   ! printf '%s' "$result" | jq -e '.ok == true' >/dev/null; then
  printf '%s\n' "$result" | jq .
  exit 1
fi

人向けメッセージの一部ではなく、終了コードと.okを組み合わせて判定します。