아이템 28

API 안정성을 확인하라

프로그래밍에서 안정적이고 최대한 표준적인 API를 선호한다. 주요 이유는 다음과 같다.

1. API 변경된다면 여러 코드를 수동으로 업데이트해야 한다.
2. 안정적이고 표준적이지 않다면 사용자가 새로운 API를 배워야 한다.

하지만 좋은 API를 한번에 설계하는 것은 힘들다. 따라서 계속해서 API를 안정적으로 유지하기 위해 의견을 제시해서 균형을 맞춰야 한다.

API를 안정적으로 운영하기 위해서는 다음과 같이 행동할 수 있다.

1. API가 불안정하면 명확하게 알려줘야 한다. major, minor, patch 버전 을 나눠서 버전 별로 배포한다. 단 major 가 0이면 초기 개발 전용 버전을 의미하며, 안정적이지 않는 것을 의미한다. (tmi. 코틀린도 0 버전대가 5년이상 걸림)
2. 안정적인 API에 새로운 요소를 추가할 때 다른 브랜치에 두는 것이 좋다.
3. Main에 배포되었다면 메타 어노테이션으로 설명을 남겨두는 것이 좋다.
   @Experimental: 배타버전임을 나타냄
   @Deprecated: 변경될 예정
   Replacewith: IDE가 자동으로 지정한 대안으로 전환