mcpField
A
api-changelog-versioning

api-changelog-versioning

github.com/aj-geddes開発373474 回インストール34 週間前に更新
リポジトリ

api-changelog-versioning について

APIの変更、非推奨、破壊的変更、移行方法を記録するスキルです。バージョン比較とセマンティックバージョニングの実践にも対応します。

主な機能

  1. 01バージョン別のAPI変更記録
  2. 02破壊的変更の明示
  3. 03例を含む移行ガイドの作成
  4. 04非推奨項目とサポート方針の記録
  5. 05セマンティックバージョニングの適用

活用シーン

  1. 01リリース変更履歴の作成
  2. 02APIの破壊的更新の説明
  3. 03利用者のアップグレード支援
  4. 04非推奨の期間の記録

インストール

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

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill api-changelog-versioning

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
breaking-changes.md
improvements.md
new-features.md
security.md
step-1-update-base-url.md
scripts/
validate-api.sh
templates/
api-scaffold.yaml

詳細

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

目次

概要

変更、非推奨化、破壊的変更を記録し、API 利用者向けの移行ガイドを提供する、包括的な API 変更履歴を作成します。

使用する場面

  • API バージョンの変更履歴
  • 破壊的変更のドキュメント
  • バージョン間の移行ガイド
  • 非推奨化のお知らせ
  • API アップグレードガイド
  • 下位互換性に関する注記
  • バージョンの比較

クイックスタート

  • バージョンの比較
# API Changelog

## Version 3.0.0 - 2025-01-15

### 🚨 Breaking Changes

#### Authentication Method Changed

**Previous (v2):**

```http
GET /api/users
Authorization: Token abc123
```

## Reference Guides

Detailed implementations in the `references/` directory:

| Guide | Contents |
|---|---|
| [🚨 Breaking Changes](references/breaking-changes.md) | 🚨 Breaking Changes |
| [✨ New Features](references/new-features.md) | ✨ New Features |
| [🔧 Improvements](references/improvements.md) | 🔧 Improvements |
| [🔒 Security](references/security.md) | 🔒 Security, 🗑️ Deprecated, 📊 Version Support Policy |
| [Step 1: Update Base URL](references/step-1-update-base-url.md) | Step 1: Update Base URL, Step 2: Migrate Authentication, Step 3: Update Response Parsing, Step 4: Update Error Handling (+2 more) |

## Best Practices

### ✅ DO

- Clearly mark breaking changes
- Provide migration guides with code examples
- Include before/after comparisons
- Document deprecation timelines
- Show impact on existing implementations
- Provide SDKs for major versions
- Use semantic versioning
- Give advance notice (3-6 months)
- Maintain backward compatibility when possible
- Document version support policy

### ❌ DON'T

- Make breaking changes without notice
- Remove endpoints without deprecation period
- Skip migration examples
- Forget to version your API
- Change behavior without documentation
- Rush deprecations

コメント

Markdown 対応