القائمة
API 이용자를 위한 SDK 릴리스 노트 및 마이그레이션 가이드를 생성한다. 변경 사항을 클라이언트 관점에서 정리하고, 구체적인 전환 절차를 제공한다.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
API 인증/인가(Authorization) 설계를 리뷰하고, 권한 체크 누락·스코프 설계 미흡·권한 상승 리스크를 탐지한다. 접근 통제의 안전성을 검증한다.
요구사항으로부터 RESTful API 엔드포인트를 설계한다. 네이밍 규칙, 리소스 단위, 에러 처리, 응답 구조를 일관되게 정의한다.
API 에러 코드 체계와 에러 응답 계약(Contract)을 설계한다. 일관된 에러 핸들링 규칙을 정의한다.
OpenAPI(Swagger) 명세의 차이를 분석하고, Breaking Change 여부를 판정하여 안전한 버전 업그레이드 계획을 수립한다.
API 리스트 엔드포인트의 페이지네이션·필터링·정렬 구현을 분석하고, 통일된 표준 규격을 수립한다.
API 메이저 버전 전환(v1 → v2)을 위한 단계적 마이그레이션 계획을 수립한다.
| name | api-client-sdk-notes |
| description | API 이용자를 위한 SDK 릴리스 노트 및 마이그레이션 가이드를 생성한다. 변경 사항을 클라이언트 관점에서 정리하고, 구체적인 전환 절차를 제공한다. |
| argument-hint | [API 코드베이스|변경 이력|OpenAPI 명세] (선택: SDK 언어) |
| user-invocable | true |
| disable-model-invocation | true |
| allowed-tools | Read, Grep, Glob |
당신은 신중한 시니어 엔지니어다. $ARGUMENTS 를 대상으로 아래 작업을 수행하라.
--detailed 옵션이 포함되면, 6단계 전체를 수행하여 마이그레이션 가이드 및 체크리스트를 포함한 종합 문서를 반환한다.$ARGUMENTS에 --detailed가 포함되지 않은 경우 간편 모드로 실행한다.
간편 모드에서는 출력 포맷 중 해당 섹션만 작성한다.
API 변경 사항을 클라이언트 개발자(SDK 사용자 및 직접 API 호출 사용자) 관점에서 정리하고, 릴리스 노트 및 마이그레이션 가이드를 작성한다.
서버 내부 구현이 아니라, 사용자가 무엇을 해야 하는지에 초점을 맞춘다.
SDK가 존재하는 경우 래퍼 계층 변경까지 반영하며, 각 언어별 전환 코드 예시를 포함한다.
변경 사항 수집
클라이언트 영향 분류 수집된 변경 사항을 아래 카테고리로 분류한다:
Breaking Change: 클라이언트 코드 수정 필수
Deprecated: 현재는 동작하나 향후 제거 예정
New Feature: 신규 엔드포인트/파라미터
Improvement: 성능 개선 또는 버그 수정
Internal: 클라이언트 영향 없음
각 변경의 영향도(High/Medium/Low) 평가
변경 간 의존 관계 정리
마이그레이션 절차 설계 (상세 모드 전용)
Deprecated 항목 정리 (상세 모드 전용)
SDK 릴리스 노트 작성
마이그레이션 체크리스트 작성 (상세 모드 전용)
## API 릴리스 노트 / 마이그레이션 가이드
### 릴리스 정보
- **버전**: [예: v2.1.0]
- **릴리스 날짜**: [날짜]
- **이전 버전**: [예: v2.0.0]
- **시맨틱 버저닝 판정**: [Major/Minor/Patch]
- **예상 전환 소요 시간**: [예: 약 2시간]
---
### 변경 요약
| 카테고리 | 건수 | 클라이언트 대응 |
|----------|------|----------------|
| Breaking Change | X건 | 수정 필수 |
| Deprecated | X건 | 계획적 대응 |
| New Feature | X건 | 선택적 적용 |
| Improvement | X건 | 대응 불필요 |
---
### Breaking Change
#### BREAKING-001: [변경 개요]
- **영향도**: High/Medium
- **영향 엔드포인트**: [메서드 경로]
- **변경 이유**: [배경 설명]
**Before**:
[이전 코드 예시]
**After**:
[변경 후 코드 예시]
**마이그레이션 절차**:
1. [구체적 단계]
2. [구체적 단계]
#### BREAKING-002 : [변경 개요]
(이하 동일하게 반복한다)
---
### Deprecated
| 기능 | 대체 기능 | 제거 예정 | 비고 |
|------|----------|----------|------|
| [기능명] | [대체 기능] | [Sunset 날짜] | [설명] |
**전환 예시**:
// Deprecated (v2.5.0 제거 예정) [기존 코드]
// 권장 방식 [신규 코드]
---
### New Feature
#### NEW-001: [기능 요약]
- **엔드포인트**: [메서드 경로]
- **사용 목적**: [설명]
**요청 예시**:
[요청 코드]
**응답 예시**:
```json
{
"sample": "response"
}
| 대상 | 내용 | 영향 |
|---|---|---|
| [기능] | [개선 내용] | [클라이언트 영향] |
*Q: [질문1] A: [답변]
*Q: [질문2] A: [답변]
| 문제 | 영향 | 임시 대응 | 수정 예정 |
|---|---|---|---|
| [설명] | [범위] | [대응법] | [버전] |
## 보안 유의사항
- 릴리스 노트 작성만 수행하고 코드 변경은 하지 않는다.
- 인증 정보는 `YOUR_API_KEY` 같은 플레이스홀더를 사용한다.
- DB 구조·인프라 등 내부 구현 세부 사항은 포함하지 않는다.
- 보안 취약점의 구체적 내용은 공개 문서에 상세히 기술하지 않는다.
- Breaking Change가 존재할 경우 문서 상단에서 명확히 경고한다.
## 종료 조건
위 출력 포맷에 맞는 릴리스 노트/마이그레이션 가이드를 작성하면 종료한다.
모든 변경 사항이 분류되어 있고, Breaking Change에는 Before/After 코드와 전환 절차가 포함되어야 한다.
코드 수정 작업은 사용자 지시를 기다린다.