mcpField
A
api-changelog-versioning

api-changelog-versioning

github.com/secondsky開発242410 回インストール5 週間前に更新
リポジトリ

api-changelog-versioning について

API の変更や互換性を管理する開発者向けのスキルです。変更履歴、非推奨化の予定、バージョンのサポート方針と移行ガイドのテンプレートを扱います。

主な機能

  1. 01バージョン別の API 変更記録
  2. 02破壊的変更の明示
  3. 03非推奨化スケジュールの設定
  4. 04バージョンサポート状態の定義
  5. 05移行ガイドのテンプレート

活用シーン

  1. 01API バージョンの変更内容を公開
  2. 02旧バージョンの非推奨化とサポート終了を計画
  3. 03API レスポンス形式の移行を案内

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/secondsky/claude-skills --skill api-changelog-versioning

インストール後、Claude Code で/api-changelog-versioningを入力して読み込まれたか確認します。

詳細

API 変更履歴とバージョン管理

明確な移行手順と廃止までのスケジュールを含めて、API の変更を記録します。

変更履歴の構成

# API Changelog

## v3.0.0 (2025-01-15) - Breaking Changes

### Breaking Changes
- Response format now follows JSON:API specification
- Authentication switched from API tokens to JWT Bearer

### Migration Steps
1. Update base URL to `/api/v3`
2. Replace `Authorization: Token xxx` with `Authorization: Bearer xxx`
3. Update response parsing for new envelope format

## v2.5.0 (2024-12-01) - Features

### New Features
- Webhook support for order events
- Batch operations endpoint
- Field filtering via `?fields=` parameter

### Improvements
- 56% faster response times on /products
- Enhanced error messages with field-specific suggestions

廃止スケジュール

バージョンステータスサポート終了日
v3.x現行完全サポート
v2.xメンテナンス2025-06-01
v1.xサポート終了サポート対象外

バージョンサポートポリシー

  • 現行：完全サポート、新機能を提供
  • メンテナンス：バグ修正とセキュリティ対応のみ
  • サポート終了：サポート対象外、ドキュメントから削除

移行ガイドのテンプレート

## Migrating from v2 to v3

### Before (v2)
```json
{ "user_name": "john" }
移行後（v3）
{ "data": { "type": "user", "attributes": { "name": "john" } } }
手順
  1. SDK を v3.x に更新します
  2. レスポンスハンドラーを変更します
  3. ステージング環境でテストします
  4. 本番環境を更新します

## Best Practices

- Provide 3-6 months deprecation notice
- Include before/after code examples
- Mark breaking changes prominently
- Maintain backward compatibility when feasible
- Version via URL path (`/api/v1/`) for clarity

コメント

Markdown 対応