API Versioning
API 버전 관리
API 버전 관리는 클라이언트에 영향을 주지 않고 API 계약을 명명, 변경, 지원 및 폐기하는 계획입니다. 모든 API가 반드시 사용해야 하는 URL이나 헤더 스타일은 없습니다.
다른 예시
급여 API는 OpenAPI 계약 `2026-07`을 발표하고 `/v1` 클라이언트의 작동을 유지합니다. 선택적 필드 추가는 이를 깨뜨리지 않습니다. `netPay`를 정수 센트에서 소수로 변경하려면 새로운 주 버전 계약이 필요합니다. 또한 이전 안내, 폐기 헤더, 사용 데이터, 종료 날짜가 필요합니다.
주요 부분
- 01계약 식별자
- 02호환성 규칙
- 03사용 중단 및 마이그레이션
사용할 때
호환성 규칙, 변경 유형, 검색 방법, 지원 기간 및 사용 중단 정책을 먼저 설정합니다. 그런 다음 경로, 미디어 유형 또는 헤더 스타일을 선택합니다.
다음 경우에는 사용하지 마세요
매 릴리스마다 새로운 API 버전을 만들지 마십시오. 사용 데이터와 오래된 버전을 종료할 방법 없이 지원을 영원히 약속하지 마십시오.
코드에서 사용된 이름
explicit compatibility policy + versioned OpenAPI document + deprecation and sunset lifecycle 출시하기 전에
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome:Complete the task with API 버전 관리 (API Versioning)。 User context:급여 API는 OpenAPI 계약 `2026-07`을 발표하고 `/v1` 클라이언트의 작동을 유지합니다. 선택적 필드 추가는 이를 깨뜨리지 않습니다. `netPay`를 정수 센트에서 소수로 변경하려면 새로운 주 버전 계약이 필요합니다. 또한 이전 안내, 폐기 헤더, 사용 데이터, 종료 날짜가 필요합니다. Technical concept or control:API 버전 관리 (API Versioning)。 Why it fits:호환성 규칙, 변경 유형, 검색 방법, 지원 기간 및 사용 중단 정책을 먼저 설정합니다. 그런 다음 경로, 미디어 유형 또는 헤더 스타일을 선택합니다. Do not use it when:매 릴리스마다 새로운 API 버전을 만들지 마십시오. 사용 데이터와 오래된 버전을 종료할 방법 없이 지원을 영원히 약속하지 마십시오. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary):하나의 공식 표준이 전체 용어를 통제하지 않음. 의미는 팀, 플랫폼 또는 프레임워크마다 달라질 수 있음. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
이 요청을 확인하세요
Review how API 버전 관리 (API Versioning) is used now. Definition: API 버전 관리는 클라이언트에 영향을 주지 않고 API 계약을 명명, 변경, 지원 및 폐기하는 계획입니다. 모든 API가 반드시 사용해야 하는 URL이나 헤더 스타일은 없습니다. Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.