[iOS-factor] VI. 이전 버전과 호환되는 API
모든 유저가 최신 버전을 사용한다고 가정하지 마세요.
2018.06.03
by Felix Krause, translated by pilgwon
목차
- 시작하며
- I. 디펜던시(Dependencies)
- II. 설정(Config)
- III. 개발/라이브 동일시하기(Dev/prod parity)
- IV. 배포(Deployment)
- V. 원격보다 로컬 선호하기(Prefer local over remote)
- VI. 이전 버전과 호환되는 API(Backwards compatible APIs)
- VII. 앱 버전 정하기(App versioning)
- VIII. 데이터의 지속성(Persistence of data)
여러분의 엔드 유저의 대부분이 가장 최근의 업데이트를 몇 주 안에 업데이트하는 동안, 항상 거기엔 반대되는 업데이트 하지 않은 나머지 유저들이 있습니다. 이러한 데에는 이유가 있습니다. 보통 그들의 iOS 버전에 관계가 있으며, 주어진 iOS 장치의 나이에 따라 항상 업데이트 할 수는 없습니다.
여러분은 1세대 iPad(2010년형)에서 Facebook Messenger를 사용할 수 있습니다. 새로운 기능은 지원되지는 않지만, 핵심 기능은 API 버저닝 덕분에 여전히 가능합니다.
기본적인 컨셉은 기존 API는 업데이트 하지 않고, 새로운 API를 만들어서 평행으로 실행되도록 하는 것입니다.
https://your-api.com/1.0/drivers.json
https://your-api.com/1.1/drivers.json
결국에는 API를 지원 종료하거나 약간 변경해야 할 수도 있습니다. 회사가 안정성에 대한 깊은 의지를 가지고 있음에도 불구하고, 가끔씩 법률 문제가 이를 변화하게 만듭니다. 그 말인 즉슨, API 엔드포인트를 API 상태를 알 수 있도록 쿼리가 가능하게 만들어야 한다는 뜻입니다.
https://your-api.com/1.0/status.json
https://your-api.com/1.1/status.json
상태 API는 다음과 같은 정보를 포함해야 합니다.
- API의 상태가 어떤가요? (예. 테스팅, 베타, 라이브)
- API가 depreciated 되었나요? 그렇다면, 종료되는 날짜는 언젠가요?
- API가 오프라인인가요? 만약 그렇다면, 계속해서 오프라인인가요 아니면 임시적인 상태인가요?
전체 소스 코드는 GitHub에서 확인하실 수 있습니다.
이 프로젝트는 Felix Krause에 의해 시작되었습니다.
이 프로젝트는 Apple과 아무 관계가 없습니다.