2021. 6. 29. 00:41ㆍDev/REST
URI 설계 기본 규칙
1. 슬래시 구분자는 계층 관계를 나타내는데 사용한다.
2. URI 마지막 문자로 ( / ) 는 포함하지 않는다.
https://test.com/user/points/ ---- X
https://test.com/user/points ---- O
3. 하이픈( - )은 가독성을 높이기 위해 사용한다.
불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.
4. 밑줄( _ )은 사용하지 않는다.
https://test.com/user/points/member_ship ---- X
5. 대문자보다는 소문자를 사용한다.
https://test.com/USER/POINTS ---- X
https://test.com/user/points ---- O
6. 파일 확장자는 URI에 포함하지 않는다.
메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
Accept header를 사용한다.
Ex) http://test.com/members/345/photo.jpg (X)
Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
7. 프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.
https://test.com/user/point.do ---- X
8. 자원에 대한 행위는 동사가 아닌 HTTP Method로 표현한다.
https://test.com/user/get/point ---- X
https://test.com/user/100/READ ---- X
GET https://test.com/user/1/point ---- O
9. 경로 부분 중에서 변하는 부분은 유일한 값으로 대체한다.
/students/{student-id}/class/{class-id}
10. API에 있어서 서브도메인은 일관성 있게 사용해야 한다.
https://test.com (원 도메인)
https://api.test.com (API 도메인)
https://dev-api.test.com (개발 API 도메인)