APIのバージョン管理と廃止ポリシー

Inblog API v1の現在のサポート状況、将来の廃止シグナル、サポート終了までの告知原則を説明します。

InblogのREST APIはURLパスにバージョンを含めるため、自動化ツールから予測可能な契約を利用できます。

現在のサポート

v1は現在サポートされているREST APIバージョンです。連携を構築するときは、/api/v1/...配下のエンドポイントとOpenAPIドキュメントを利用してください。

サポート対象のv1操作では後方互換性を維持します。レスポンスフィールドの追加など、互換性を壊さない改善は新しいURLバージョンを作らずに導入されることがあります。現在、v1の廃止またはサポート終了日は発表されていません。

このポリシーが存在するだけで、v1のレスポンスにDeprecationまたはSunsetレスポンスヘッダーを付けることはありません。現在ヘッダーがないことは、終了シグナルが発表されていないことを意味します。

サポート中のAPIバージョンの終了が予定された場合、Inblogは次のレスポンスヘッダーを使用することがあります。

この2つは異なるシグナルです。廃止はライフサイクルの変更を知らせ、Sunsetはサポート終了の予定日を示します。ヘッダーが存在する場合は両方を記録し、関連するドキュメントや移行ガイドを確認してください。

通常は、v1を削除する前、またはサポート対象のAPIバージョンに破壊的変更を加える前に、最低180日間の告知期間を設けます。これは保守的な最低基準であり、すべての変更が必ずこの日程で行われるという意味ではありません。

セキュリティ上の脆弱性、法的要件、または緊急事態では、告知期間を短縮したり、直ちに変更したりする必要が生じる場合があります。その場合も、可能な限り早く影響と対応方法をお知らせします。