本番環境で運用中のAPIスキーマを変更する際の流れと注意点は？
→ 複数環境で動作検証後、本番環境への反映を推奨します。
APIスキーマの変更は即時反映されるため、慎重な運用が必要な操作となります。
複数環境を利用して、事前に動作検証を行うことを推奨します。
変更の流れ
本番環境で運用中のAPIスキーマを変更する際は、以下の流れがベストプラクティスとなります。
- APIスキーマのエクスポート機能で、必要に応じて変更前のAPIスキーマをバックアップしておく
- 複数環境で変更後のAPIスキーマの動作を確認する
- 正常動作の確認が取れた後、変更を本番環境へ展開する
注意点
APIスキーマの変更に関する注意点を列挙します。
- 複数環境はBusinessプラン以上で利用可能な機能となっています。
- 複数環境から本番環境へ設定内容を反映する機能は提供しておりません。
本番環境への変更の展開は、API設定から手動で変更する必要があります。 - APIスキーマのバージョン管理には対応しておりません。
バージョン管理が必要な場合は、エクスポートしたファイルをGitHubなどで管理する運用となります。
ただし、運用中のAPIスキーマはファイルのインポートで変更できないため、ロールバックの際はAPI設定から手動で変更する必要があります。