Export/Import of API Schema
To facilitate the creation of similar APIs in other services, microCMS supports the export and import of API schemas.
By exporting the API schema as a JSON file and importing this JSON file during API creation, you can eliminate the need for manual configuration.
InformationYou can also obtain the API schema using the API.
For more details, please refer to the Management API documentation.
Exporting API Schema
First, let’s explain how to export.
Select the content for which you want to export the API schema, then choose "API Settings" → "API Schema".
Next, a button labeled "Export this setting" will appear at the bottom of the screen, so please click it.
You can download the resulting JSON file.
- Information
Depending on your permissions, you may not be able to access this screen or perform the import operations listed below.
In such cases, please check the permission management status or contact your service administrator.
Importing API Schema
First, let’s explain how to import.
Importing is done by loading the JSON file you downloaded earlier during the API schema setup.
Start creating the API from the menu on the left side of the management screen at ①. After entering the basic information for the API and selecting the API type, the screen for "Defining API Schema" will be displayed below, so please select the file from the link at ② that says "Click here if you want to import a file."
- Information
If the content reference or multiple content reference fields are included, the information from the referenced content will not be imported.
Please note that you will need to set the referenced API again after creating the API.