Restful API 를 구현하다보면 자연스럽게 하는것중 하나가 바로 API Versioning 이지 않을까 싶습니다.

하지만 막상 이렇게 API 에 Versioning 을 해도 제대로 활용하지 못하는 경우들이 많을텐데요
API Versioning 을 언제 어떻게 사용해야하는지 명쾌하게 설명한 글이 있어 공유드립니다.

글의 내용을 간단히 정리해보면 다음과 같습니다.

📌 API Versioning 방법
 * URI Versioning: "/api/v1/hello" 와 같이 URI 에 version 을 명시하는 방식
 * Media Type Versioning: "Accept: application/json; v=1" 과 같이 HTTP Accept Header 에 version 을 명시하는 방식

📌 API 공개 대상에 따른 Versioning 여부
 * Public API: 누구에게나 제공하는 API 이기 때문에 필요. 웹 문서 등을 통해 API 의 수명주기를 잘 관리해주어야 한다.
 * Private API: 사내에서 서비스간 연동 목적으로 사용하는 API 이기 때문에 변경사항에 대해 공유가 가능하고 integration 및 품질 테스트 등을 통해 이슈를 해결할 수 있어 version 관리가 필요하진 않다.
 * Partner API: API 를 제공하는 Partner 의 범위나 개발 지속성 여부에 따라 필요할 수도 있고 필요 없을 수도 있습니다.

📌 Version 업데이트는 언제 해야할까?
 * API 리소스 엔드포인트의 이름이나 경로, HTTP 메서드를 바꾸거나 삭제할 경우
 * 열거형(enum type)값 이름 변경 혹은 삭제
 * 필드의 타입 변경(이전 타입까지 수용할 수 있는 경우는 해당하지 않음)
 * 수행했던 작업이나 응답 포맷이 변경되는 경우

📌 API 버전을 새로 릴리즈할 때 진행 과정
 * API 개발팀이 변경 사항을 만들고, 새 버전을 생성한 다음 테스트합니다.
 * 새로운 인스턴스 및 프로덕션 파이프라인을 설정하고 배포합니다.
 * 변경 내용을 문서화하고, 모든 고객에게 알립니다. 지원팀의 도움 요청에도 응해야 합니다.
 * 여러 버전을 몇 달 동안 유지하며, 고객이 그사이 최신 버전으로 전환하기를 기다립니다.
 * 기존 버전의 유효 기간까지 전환하지 않은 일부 고객은 결국 잃게 됩니다.

📌 API Versioning이 필요 없는 경우는?
 * HTTP 메서드를 추가하는 경우
 * HTTP 요청 및 응답으로 header, body에 필드를 옵션으로 추가하는 경우
 * 열거형(enum type)에 허용되는 값 추가
 * HTTP 리소스 URI가 확장되는 경우
 * 에러 응답의 상세 메시지를 바꾸는 경우
 * 에러 메시지의 아이디 적용 범위 확장
 * Rate-limit과 관련된 헤더 값 조정

이에 대한 자세한 설명은 공유드린 원문 링크를 참고해주세요.

📚 원문
 * https://yozm.wishket.com/magazine/detail/2554/

🤔 API Versioning 은 반드시 필요할까?

콜로소에서 토스, 당근, XL8 소속 엔지니어 분들과 함께 매일 새로운 문제를 만나는 개발자 분들을 위한 <무료 라이브 특강>을 준비했습니다.

라이브 특강은 2월 28일부터 순차적으로 총 네 차례에 걸쳐 진행되며, 개발에 관심있는 분들이라면 누구나 무료로 신청하실 수 있어요.
▶ bit.ly/48qqjWc

※이런 분들께 추천드려요.
- 내가 쓴 코드의 퀄리티를 높이고 싶은 분
- 매일 같이 눈앞의 문제만 해결하기에도 버거운 환경에 있는 분
- 협업 과정에서 업무 효율을 높이는 방법이 고민인 분
- 다음 스텝으로 가기 위해 더 뛰어난 문제 해결 역량이 필요한 모든 개발자 분들

※NEXT Solution Summit 진행 일정
2/28 (수) 토스 프론트엔드 디벨로퍼 조유성
- React 설계 의도 이해하기: 어쩌면 당신이 몰랐던 React 이론편

3/5 (화) 당근 소프트웨어 엔지니어 하태영
- 각자의 언어로 소통하기: 업무 효율을 높이는 코드 생성 기반 디자인 시스템

3/6 (수) XL8 프론트엔드 엔지니어 배휘동
- 디버깅 전문가를 만나다: 인지작업 분석으로 밝혀낸 디버깅 전문가들의 노하우

3/10 (수) 토스 프론트엔드 디벨로퍼 조유성
- React 설계 의도 이해하기: 어쩌면 당신이 몰랐던 React 실전편

신청은 하기 링크에서 3월 9일 화요일 23:59까지만 무료로 진행되고 있으며, 수강신청 후 Q&A 구글폼까지 작성해주실 경우 다양한 이벤트 혜택까지 제공해 드리고 있으니 많은 분들의 관심 부탁드립니다☺️
▶ bit.ly/48qqjWc

시니어 콘텐츠 마케터

콜로소 무료 Live 특강 안내 [NEXT Solution Summit]

안녕하세요!
제가 기획/운영하고 있는 패스트캠퍼스 백엔드 개발 부트캠프 8기가 2월 오픈을 준비하고 있습니다. 부트캠프 홍보와 함께 커피챗 모집글도 올려 봅니다.

새해가 되어 사이드 프로젝트 등 여러가지 계획을 세우고 계실 텐데요. 저희 부트캠프는 수강생 뿐만 아니라, 멘토와 강사의 커리어 성장을 지향하고 있습니다.

- 멘토로서 커리어 성장을 원하는 주니어/시니어 백엔드 개발자
- 강사로서 새로운 커리어를 준비하는 시니어 백엔드 개발자

위에 해당하시는 분들이나, 추천해주실만한 지인이 있으시다면,
언제든 DM/커피챗 요청 환영입니다!

https://fastcampus.co.kr/b2g_MegabyteSchool_backend

Product Manager

인턴

마케터

광석

백엔드 개발자

TS 백엔드 개발자\n#백엔드 #개발자

평일엔 개발자 주말엔 까미형아

영진

교육이란 사람들이 선한 일을 할 수 있도록 돕는 것이라 여기며, \n좋은 교육 제품을 통해 선한 세상을 만듭니다.\n\n#패스트캠퍼스 #교육 #프론트/백엔드 부트캠프 #멘토링 

교육 Product Manager

유연수

제로베이스

스펙, 나이 상관 없이 제로베이스와 함께라면 취업이라는 목적지에 도착할 수 있습니다. 제로베이스부터 시작하는 커리큘럼, 검증된 강사진이 취업까지 함께 합니다.

데이원컴퍼니 제로베이스

Juhee An

콘텐츠 상품 기획자

성인 교육 플랫폼 패스트캠퍼스에서 프로그래밍 교육 콘텐츠를 제작하고 있습니다.

패스트캠퍼스 콘텐츠 상품 기획자

강희원

시니어 콘텐츠 기획자

끊임없이 실행하고 회고하여 성장하는 기획자 입니다. 상품의 아이디어에서 부터 출시까지의 사이클을 20번 이상 반복하며, 실패와 성공의 공식을 구축하고 있습니다.

최상아

콘텐츠 상품 기획자 인턴

사람들의 습관을 바꿀 서비스를 만드는 기획자가 목표입니다.\n19살에 조향사에 꿈을 품고 24살까지 전시기획, 조향, 창업을 했습니다.\n26살에 창업지원센터에서 매니저, 27살 카카오 서비스비즈 인턴십을 했습니다.\n일을 맡기고 확인하지 않아도 되는 동료가 되고 싶습

디지털 노마드를 꿈꾸는 자유인

김경수

IT 교육 콘텐츠 기획 

노하은

프로덕트 매니저

패스트캠퍼스 프로덕트 매니저

김승주

기획

패스트캠퍼스 기획

김도연

매니저

소프트웨어 엔지니어

이윤정

Talent Acquisition Specialist 및 교육 상품 기획/개발

안녕하세요 :)\n패스트캠퍼스에서 이것저것 하고있습니다\n#기획자 #네트워킹 #디지털마케팅 #스타트업

패스트캠퍼스 Talent Acquisition Specialist

수양

데이터 분석가

day1company 데이터 분석가

조수현

데이원컴퍼니 PM

박재정

데이원컴퍼니 백엔드 개발자

김진기

퍼포먼스 마케터

사소한 것 하나라도 발견하는 사람입니다.\n문제를 찾았다면 개선하고 해결하고 싶습니다. \n일에서 성취를 얻을 수 있다면 달려갑니다.\n#그로스마인드셋 #기획자 #퍼포먼스마케팅 #데이터분석

데이원컴퍼니 마케터

김소연

시니어 프로덕트 매니저

Senior Product Manager (사업기획)

김경태

DT 커리어팀

이어드림 스쿨 담당 매니저 \n#데이터사이언스 #Ai

데이원컴퍼니 DT 커리어팀

정지선

성인 교육 플랫폼 패스트캠퍼스에서 프로그래밍 & AI 교육 콘텐츠를 기획하고 있습니다.\n\n

정성균

디지털 마케터 Senior

안녕하세요! \n한번 시작한 일은 끝까지 열심히. \n그리고 열심히만 하는 건 재미없어요 :-( \n성과까지 만들어내야 직성이 풀리는 \n8년차 Marketer이자 MD 송유진입니다 :-) \n#콘텐츠기획 #마케터 #커뮤니케이션 #긍정적인 #끊임없이배우기 #블로거 #여

데이원컴퍼니 디지털 마케터 Senior

송유진

기획본부 파트장

데이원컴퍼니 기획본부 파트장

어효경

교육 콘텐츠 기획

김미소

콘텐츠 에디터

데이원컴퍼니 콘텐츠 에디터

은혜

하린

CAMP사업본부, Coloso사업본부 콘텐츠 마케터

3년차 콘텐츠 마케터이자 디자이너

콘텐츠 마케터 / 콘텐츠 디자이너

고석균

데이원컴퍼니 매니저

패캠스쿨

승완

시니어 고객지원 매니저

데이원컴퍼니 시니어 고객지원 매니저

박미현

상품 기획 기획

데이원컴퍼니 상품 기획 기획

안수빈

콘텐츠 개발자

패스트캠퍼스 콘텐츠 개발자

데이원컴퍼니 프로덕트 매니저

Jinsung Jun

두영

디지털마케팅

패스트캠퍼스 디지털마케팅

권소라

FE과정

프론트엔드 개발자

영프로

패스트캠퍼스 커리어 매니저

윤예빈

#커뮤니케이션 #팀플레이어 #사용자조사 #기획자 #긍정적인 #콘텐츠기획 #문제를해결하는 #질문하는 #도전적인 #끊임없이배우기

예진

교육관리 매니저

패스트캠퍼스 데이터 분석 부트캠프 LM

정지훈

기획 팀장/기획그룹

Senior Product Manager

도예원

교육 기획/운영 매니저

데이원컴퍼니 교육 기획/운영 매니저

이희상

학습매니저

데이원컴퍼니 학습매니저

이지선 Dany rhi

교육/심리에 관심 있는 콘텐츠상품 기획자

권혜지

데이원컴퍼니 프론트엔드 개발자

동원

Senior Manager

데이원컴퍼니 Senior Manager

고혜승

사업개발

전략 기획

김영찬

elegantcoder

전략기획팀

전략기획팀/주니어 매니저

이준성

프로덕트 마케터

yumin catherine park

그로스 마케터

한누리

데이원컴퍼니 소프트웨어 엔지니어

JooYoungTaek

임옥택

박수진

디지털 마케팅

패스트캠퍼스

FE 매니저

데이원컴퍼니 FE 매니저

은지

동주동

운영 매니저

서울여자대학고 교육심리학과

김유림

학습관리 매니저

데이원컴퍼니 학습관리 매니저

김유영

패스트캠퍼스 디지털 마케팅

김보경

데이원컴퍼니 시니어 콘텐츠 마케터

패스트원 4:1 그룹과외

오소영

사업기획자

데이원컴퍼니 사업기획자

이승연

Marketer

권미정

김예닮

패스트캠퍼스 PM

장혜리

컴퓨터공학

사원

윤서

분분

스쿨팀 매니저

데이원컴퍼니 스쿨팀 매니저

조용하

강지연

UX 디자이너

데이원컴퍼니 UX 디자이너

로로롱

사업본부장

데이원컴퍼니 레모네이드 사업본부장

박수영

기획자

데이원컴퍼니 기획자

프로덕트 디자이너

데이원컴퍼니 프로덕트 디자이너

김현정

콘텐츠 마케터

데이원컴퍼니 콘텐츠 마케터

정지영

SYSY

시니어 매니저

데이원컴퍼니 시니어 매니저

upcareerly

상품 기획 PN

데이원컴퍼니 상품 기획 PN

민민

민경

데이원컴퍼니

song

sunny

데이원 컴퍼니 프로덕트 매니저

이유나

기술 스택

언어

typescript

프론트엔드

React

백엔드

Google Cloud Platform

NestJs

데이터베이스

MySQL

데브옵스

Github

데이원컴퍼니