メインコンテンツまでスキップ

API 廃止ポリシー

API の廃止ポリシーを説明します。

対象読者

  • 開発チームメンバー

基準

  • 利用状況: 利用頻度が低い API を優先して廃止
  • 新機能導入: 新しい API の導入に伴う旧 API の廃止
  • セキュリティ: セキュリティリスクが存在する場合は非推奨期間を設けず即時廃止

プロセス

変更はセマンティックバージョニング規約に従います。

  1. 通知: OpenAPI ドキュメントで非推奨を通知
  2. 無効化: エンドポイントを無効化
  3. リリース: メジャーバージョンのリリース時に廃止