URI 설계 원칙(RFC-398)
- 슬래시는 계층 관계 나타 낼 때 사용
- URI 마지막은 ( / ) 포함하지 않음
- 하이픈( - ) 가독성을 높일 때 사용
- 밑줄( _ ) 은 사용하지 않음
- URI 경로는 소문자만 사용
- 파일 확장자를 포함하지 않는다.
- 프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.
- 구현에 의존적인 경로를 자용하지 않는다.
- 세션 ID 포함하지 않는다.
- Method 명을 사용 하지않음
- 복수형을 지향 , 컬렉션에 대한 표현은 복수로 사용
- 컨트롤러 이름으로는 동사나 동사구를 사용한다
- 경로 부분 중 변하는 부분은 유일한 값으로 대체(Path Variable)
Https://foo.co.kr/{car-id}/users/{user-id}/release
Https://foo.co.kr/155/users/155/release
- CRUD 기능은 나타내는 것은 URI 에 사용하지 않는다.
- URI Query Parameter 디자인
- API에 있어서 서브 도메인은 일관성 있게 사용해야한다.
- 클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다.