jpskill.com
🛠️ 開発・MCP コミュニティ

api-changelog-versioning

Document API changes, breaking changes, migration guides, and version history for APIs. Use when documenting API versioning, breaking changes, or creating API migration guides.

⚡ おすすめ: コマンド1行でインストール(60秒)

下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。 ダウンロード → 解凍 → 配置まで全自動。

🍎 Mac / 🐧 Linux
mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o api-changelog-versioning.zip https://jpskill.com/download/21324.zip && unzip -o api-changelog-versioning.zip && rm api-changelog-versioning.zip
🪟 Windows (PowerShell)
$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/21324.zip -OutFile "$d\api-changelog-versioning.zip"; Expand-Archive "$d\api-changelog-versioning.zip" -DestinationPath $d -Force; ri "$d\api-changelog-versioning.zip"

完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。

💾 手動でダウンロードしたい(コマンドが難しい人向け)
  1. 1. 下の青いボタンを押して api-changelog-versioning.zip をダウンロード
  2. 2. ZIPファイルをダブルクリックで解凍 → api-changelog-versioning フォルダができる
  3. 3. そのフォルダを C:\Users\あなたの名前\.claude\skills\(Win)または ~/.claude/skills/(Mac)へ移動
  4. 4. Claude Code を再起動

⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。

🎯 このSkillでできること

下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。

📦 インストール方法 (3ステップ)

  1. 1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
  2. 2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
  3. 3. 展開してできたフォルダを、ホームフォルダの .claude/skills/ に置く
    • · macOS / Linux: ~/.claude/skills/
    • · Windows: %USERPROFILE%\.claude\skills\

Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。

詳しい使い方ガイドを見る →
最終更新
2026-05-18
取得日時
2026-05-18
同梱ファイル
7

📖 Skill本文(日本語訳)

※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。

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
```

リファレンスガイド

references/ディレクトリにある詳細な実装です。

ガイド 内容
🚨 Breaking Changes 🚨 破壊的変更
✨ New Features ✨ 新機能
🔧 Improvements 🔧 改善
🔒 Security 🔒 セキュリティ、🗑️ 非推奨、📊 バージョンサポートポリシー
Step 1: Update Base URL Step 1: ベースURLの更新、Step 2: 認証の移行、Step 3: レスポンス解析の更新、Step 4: エラー処理の更新(他2項目)

ベストプラクティス

✅ するべきこと

  • 破壊的変更を明確にマークする
  • コード例付きの移行ガイドを提供する
  • 変更前/変更後の比較を含める
  • 非推奨化のタイムラインを文書化する
  • 既存の実装への影響を示す
  • 主要バージョン向けにSDKを提供する
  • セマンティックバージョニングを使用する
  • 事前通知(3〜6ヶ月前)を行う
  • 可能な場合は後方互換性を維持する
  • バージョンサポートポリシーを文書化する

❌ するべきではないこと

  • 通知なしに破壊的変更を行う
  • 非推奨期間なしにエンドポイントを削除する
  • 移行例を省略する
  • APIのバージョン管理を忘れる
  • ドキュメントなしに動作を変更する
  • 非推奨化を急ぐ
📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開

API Changelog & Versioning

Table of Contents

Overview

Create comprehensive API changelogs that document changes, deprecations, breaking changes, and provide migration guides for API consumers.

When to Use

  • API version changelogs
  • Breaking changes documentation
  • Migration guides between versions
  • Deprecation notices
  • API upgrade guides
  • Backward compatibility notes
  • Version comparison

Quick Start

  • Version comparison

# 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

同梱ファイル

※ ZIPに含まれるファイル一覧。`SKILL.md` 本体に加え、参考資料・サンプル・スクリプトが入っている場合があります。