• 카테고리

    질문 & 답변
  • 세부 분야

    웹 개발

  • 해결 여부

    미해결

현업에서 API 수정할 때 과정이 궁금합니다.

22.10.26 11:36 작성 조회수 382

1

=========================================
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예)

[질문 내용]
무중단 배포 환경에서의 API 수정 사항, 예를들면 DB의 수정이라던지, API의 스펙 자체를 변경해야할 때의 경우에는 어떤식으로 수정사항을 적용하는지 궁금합니다.

제가 사용한 방법으로는 기존 API에서 수정을 해서 바로 적용을해도 서비스에 지장이 없는 경우에는 API를 수정 후 테스트까지 하고 배포를 하는데, 만약 기존 API를 수정했을 때 기존에 작동하고 있는 서비스에 문제가 생길 경우에는

  1. 새로운 API 경로로 수정된 API를 작성 후 적용

  2. API를 호출하는 곳(프론트)에서 새로운 API 경로로 변경

  3. 프론트에서 새로운 API 경로로 변경이 완료되면 기존 api 삭제

위와 같은 방식으로 진행을 하는게 맞는지 더 좋은 방법이 있는지 궁금합니다.

답변 1

답변을 작성해보세요.

3

안녕하세요. 휘율님

API의 필드를 추가하는 정도면 기존 API를 사용합니다.

API에 너무 많은 변경이 있거나 기존 필드에 변경이 있다면(수정, 삭제등) 이때는 새로운 API를 생성해서 사용합니다.

감사합니다.

휘율님의 프로필

휘율

2022.10.30

답변해주셔서 감사합니다.

 

추가적으로 궁금한점이 있습니다.

 

유저의 결제를 받는 API가 있고 해당 API의 경로가

[POST] /payments 라고 했을 때 이 API가 변경사항이 많아 새로운 API를 만들어서 해야 한다 하면

/payments API가 이미 존재하는데 새로운 API 경로는 어떻게 설계하는지 궁금합니다.

 

경로에 /v1, /v2 처럼 버전을 다는 것을 생각해봤는데, 다른 API들은 전부 v1 버전을 사용하는데 바뀌는 API만 v2로 올려서 작업해도 괜찮을지 궁금합니다.

 

아니면 다른 좋은 방법이 있는지 궁금합니다.

안녕하세요. 휘율님

상황에 따라서 각각 장단이 있겠지만, 해당 API의 버전을 올리는 것을 권장합니다.

감사합니다.