advanced
REST APIの高度なバージョニング戦略
RESTful APIの長期的な保守性と後方互換性を両立させるためのバージョニング方針に関する技術仕様書を作成します。
📝 Contenu du Prompt
大規模なエンタープライズ向けSaaSプラットフォームのREST APIバージョニング戦略に関する技術仕様書を作成してください。
以下のポイントを含める必要があります。
1. **バージョニング手法の選定**: URIバージョニング、ヘッダーベースのバージョニング、コンテンツネゴシエーションの比較検討と、最終的な推奨事項。
2. **非互換性の定義**: どのような変更がメジャーバージョンの更新を必要とするかの明確なガイドライン。
3. **廃止ポリシー (Deprecation Policy)**: 旧バージョンのサポート期間、通知スケジュール、および廃止時のエラーハンドリング。
4. **マイグレーションガイド**: クライアント開発者向けの移行手順と自動化ツールの提案。
5. **出力形式**: 構造化されたMarkdownドキュメント。