[좋은 API 설계하기] API 버전 정책 (feat. 토스페이먼츠)

토스페이먼츠 정책

API 버전 정책 링크 

 

	기존 버전을 수정하는 경우 (v1)	새로운 버전을 릴리즈 하는 경우 (v2, v3, v4 .. 등)
엔드 포인트	새로운 API 엔드포인트 추가	기존 API 엔드포인트 제거
파라미터 (요청)	API 요청에 새로운 선택 파라미터 추가 API 요청에서 사용하는 필수 파라미터를 선택 파라미터로 변경	API 요청에 새로운 필수 파라미터 추가 API 요청의 선택 파라미터를 필수 파라미터로 변경
응답	API 응답에 새로운 필드 추가	API 응답에 사용되던 필드 삭제 API 응답 nullable 하지 않았던 필드를 nullable 변경 API 응답 필드의 데이터 타입 변경
Enum	새로운 ENUM 추가	같은 의미를 나타내는 ENUM 코드의 변경 (예: 토스결제 → 토스페이)
에러 코드	에러 메시지 변경 새로운 에러 코드 추가	같은 의미를 나타내는 에러 코드의 변경 (예 : 4306 -> 4310 으로 변경)
기타	새로운 웹훅 이벤트 추가 웹훅 이벤트 본문에 새로운 필드 추가