GET STARTED要確認
バージョンと互換性
API のバージョンの付け方と、互換性を保つ変更・破壊的な変更の扱い、非推奨の知らせ方を説明します。
更新: 2026年10月17日
この内容は確認中です（要確認）仕様が確定していない部分を含みます。実装や運用の前に、内容を確認してください。
バージョンの付け方
API のパスには、バージョンが入ります（例：/v1/parse）。同じバージョンの中では、既存のクライアントが動き続けるように、変更を行います。
確定待ち 新しいバージョン（
v2など）を出す基準と、古いバージョンの提供期間は、決まっていません。決まり次第、このページと変更履歴に書きます。
互換性を保つ変更
次の変更は、同じバージョンの中で行います。
- 応答に、新しい項目を加える。
- 新しいエンドポイントを加える。
- 新しい任意のパラメータを加える。
クライアントは、知らない項目を無視するように作ってください。
破壊的な変更
次の変更は、破壊的な変更として扱います。
- 項目の削除、または意味の変更
- エラーの形式の変更
- 必須のパラメータを加える
実施の前に告知し、変更履歴に書きます。告知から実施までの期間は、確定待ちです。
非推奨
廃止する機能は、先に「非推奨」として、このドキュメントに書きます。非推奨の間も、動作は変えません。
変更を知る
この内容に誤りや不足があれば、お知らせください。