API 변경 시 가장 효과적인 처리 방법은 무엇인가요?

Question

안녕하세요, API 변경 처리에 대해 여러분의 의견을 듣고 싶습니다.

현재 우리 프로젝트에서는 POST api/model 엔드포인트를 사용 중입니다. 이 API의 request body 구조에 큰 변화가 필요한 상황이 발생했을 때, 어떻게 처리하는 것이 가장 좋을까요?

제가 생각한 간단한 접근 방식은 다음과 같습니다:

1. api/model2라는 새로운 엔드포인트를 생성합니다.
2. 기존 api/model을 deprecated 처리합니다.
3. 프론트엔드에서 api/model2를 사용하도록 수정합니다.
4. 일정 기간 후 api/model을 제거합니다.
5. api/model2의 이름을 api/model로 변경합니다.

이런 방식이 일반적인가요? 아니면 다른 더 효과적인 방법이 있을까요?

포크코딩 · Answer

일반적으로 사용되는 방식은 버전을 나누어 api 엔드포인트를 제공하는 것입니다.
- v1.~~.~~/api (이런 종류의 API들을 보신적 있으실 겁니다.)

기관마다 디테일은 다르나 딱 말씀하신 방법과 순서가 일반적으로 쓰이는 방식입니다.