microCMS

APIスキーマのエクスポート/インポート

最終更新日:2023年10月11日

別サービスで類似のAPIを作成する場合などのため、microCMSではAPIスキーマのエクスポート/インポートに対応しています。
APIスキーマをJSONファイルとしてエクスポートし、APIの作成時にこのJSONファイルをインポートすることで手動による設定を省くことができます。

APIスキーマのエクスポート

まずはエクスポート方法について説明します。
APIスキーマをエクスポートしたいコンテンツを選択し、「API設定」→「APIスキーマ」を選択してください。

次に画面の下部に「この設定をエクスポートする」というボタンが表示されているのでこちらをクリックしてください。
エクスポート結果であるJSONファイルをダウンロードできます。

informationInformation

権限によってはこちらの画面に到達できないことや、下記のインポート操作ができない場合があります。
そのような場合には権限管理状態をご確認いただくか、サービスの管理者様にお問い合わせください。


APIスキーマのインポート

まずはインポート方法について説明します。
インポートは先ほどダウンロードしたJSONファイルをAPIスキーマの設定時に読み込むことで行います。

管理画面左部にあるメニュー欄の①よりAPIの作成を開始します。
APIの基本情報の入力やAPIの型選択をした後に、下記の「APIスキーマを定義」の画面が表示されるので、②の「ファイルインポートする場合はこちらから」のリンクからファイルを選択してください。

informationInformation

コンテンツ参照や複数コンテンツ参照フィールドが含まれる場合は参照先の情報はインポートされません。
APIの作成後にご自身で改めて参照先APIを設定していただく必要がありますのでご注意ください。