API 모델링 및 개발 - 2

1. API 설계의 안티패턴

- GET-POST 를 이용한 터널링

- method=update 와 같은 파라미터 쿼리를 이요한 데이터 조작

- 복잡한 파라미터와 구조로 직관성 결여, 재활용성 저하

- HTTP Response code 미사용

2. API 설계 원칙

- URI 의 단순화

- api model 의 class 로 구성: /car

- 행위에 대한 정의는 좋지 않다: /getCar

- resource 간의 관계

- sub resource 표현: /user/{userID}/car/{carID}

- sub resource 간의 관계: /user/{userID}/wish/car/{carID}

- 예외-응답 코드 사용

- API 버전 관리: 

- URL: /api/v1/user , /api/v2/user

- 파라미터: /api/user?version=1 , /api/user?version=2

- 해더: "Accept-Version: 1.0" , "Accept-Version: 2.0"

- HTTP 매서드 재정의

3. API 개발 절차