API 설계의 원칙
API 설계에서 저는 일관성 · 변경 가능성 · 실패 처리 세 가지를 봅니다. 자원 명명과 HTTP 메서드 사용을 규칙으로 고정해 사용하는 쪽이 문서 없이도 예측할 수 있게 만듭니다.
변경 가능성은 버전 정책으로 다룹니다. 응답 필드는 추가에는 열어 두되 제거나 의미 변경은 새 버전으로 분리했습니다. 실패 처리가 특히 중요합니다. 오류 코드 체계를 클라이언트가 분기 가능한 수준으로 나누고, 재시도 가능 여부를 응답에 명시했습니다. 재시도 가능 여부를 알리지 않으면 클라이언트가 위험한 재시도를 하거나 복구 가능한 실패를 포기합니다.