microCMSブログ

microCMSの最新情報や活用事例などをお届けします。

更新情報

API設定を環境間でマージできるようになりました

API設定を環境間でマージできるようになりました
千葉大輔 千葉大輔

更新情報のお知らせです!

microCMSでは複数環境を活用することにより、APIスキーマやカスタムフィールドの変更を本番環境で実施する前にあらかじめテストすることができます。
ただし、これまでは複数環境で変更した設定内容を本番環境に反映するには手作業で行う必要がありました。

今回のアップデートでは、環境間のAPI設定について差分を確認・マージできる機能を追加しました!

対象プラン

複数環境機能が利用できるプラン(Businessプラン、Enterpriseプラン)

使用方法

事前にAPI設定を変更したい環境に移動してください。

1. マージ元の環境を選ぶ

環境設定画面に移動します。

環境設定を開くため、環境切り替えメニューから「設定」を選択する手順

その後、「API設定のマージ」画面に移動します。

環境設定画面から「API設定のマージ」を選択する手順

セレクトボックスで、「API設定のマージ元となる環境」を選択し、[差分を確認する]ボタンで次に進みます。

API設定のマージ画面でマージ元の環境を選択し、「差分を確認する」を選択する手順

2. 差分のあるAPIを選ぶ

その時点でAPI設定に差分のあるAPI一覧が表示されます。それぞれのAPI設定の差分を確認し、マージを実行したいAPIのチェックボックスにチェックを入れて次に進みます。

API設定の差分を確認し、マージするAPIを選択して「マージ内容を確認する」を選択する手順

3. マージの確認画面で内容を確かめる

マージ内容の確認が表示されるため、最終確認を行います。

マージ内容の確認画面でマージ可否と処理順序を確認し、「マージを実行する」を選択する手順

処理順序では、API・カスタムフィールド同士の参照関係を踏まえて問題なくマージできる順序が表示され、その順序通りにマージが実行されます。

また、このまま反映すると失敗する変更がある場合は、エラーが表示されマージの実行が行えなくなります。例えば次のようなケースです。

  • コンテンツ参照先のAPIがマージ実行後に存在しない
  • 削除対象のAPIにコンテンツが残っている

内容に問題がないことを確認してマージを実行します。
マージ対象のAPIを選び直す場合は、 「戻る」ボタンで差分確認画面に戻れます。

4. 処理状況を確認する

マージ処理の進捗は管理画面でリアルタイムに確認することができます。

API設定のマージを実行する前に、各処理を準備している画面
API設定のマージを実行し、各処理の進行状況を表示している画面
API設定のマージが完了し、すべての処理が成功したことを表示している画面

マージ対象について

API設定のマージで対象となる設定は以下となります。

  • API
    • API名・説明・APIスキーマ
  • カスタムフィールド
    • カスタムフィールド名・フィールドID・スキーマ・レイアウト

カスタムステータスやWebhookといった設定はマージの対象外となりますのでご注意いただけますと幸いです。

おわりに

今回のリリースで、環境間でAPI設定の差分を確認しながら反映できるようになりました。
複数環境側でのテスト後の本番反映や本番環境で緊急で修正した設定を複数環境側にも適用など、複数環境がより使いやすくなるアップデートになっていますのでぜひお試しください!

今後も、より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら、管理画面右下のチャットボタンよりご意見いただけますと幸いです。

ドキュメント

https://document.microcms.io/manual/environments-merge-api-settings

microCMS 採用情報

microCMSでは現在、カスタマーエンジニア・プラットフォームエンジニア・プロダクトエンジニアを積極採用中です!

ご興味のある方は、採用情報ページや弊社メンバーが業務内容やチームの雰囲気についてお話しているポッドキャスト「microCMS FM」をぜひチェックしてみてください。

カジュアル面談からでも大歓迎です。お気軽にご応募ください!

まずは、無料で
試してみましょう。

microCMSは無料ではじめられます。
ご不明な点はお気軽にお問い合わせください。