URI 설계 패턴

1. URI (Unifrom Resource Identifier)

인터넷에서 특정 자원을 나타내는 주소 값. 해당 값은 유일 하다.(응답은 달라질 수 있다.)

 

2. URL(Uniform Resource Locator)

인터넷 상에서의 자원, 특정 파일이 어디에 위치하는지 식별 하는 주소.

 

URL은 URI의 하위 개념 입니다.

 

URI 설계 원칙

1. 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용한다.

2. URI 마지막 문자로 (/)는 포함하지 않는다.

3. 하이픈(-)은 URL 가독성을 높이는데 사용한다.

4. 밑줄(_)은 사용하지 않는다.

5. URI 경로에는 소문자가 적합하다.

6. 파일 확장자는 URI에 포함하지 않는다.

7. 프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.

8. 구현에 의존적인 경로를 사용하지 않는다.

프레임워크에 문제가 발생할 수 있고, 취약점을 노출 시킬 수 있기에 사용하지 않는다.

9. 세션 ID를 포함하지 않는다.

10. 프로그래밍 언어의 Method명을 이용하지 않는다.

11. 명사에 단수형 보다는 복수형을 사용해야 한다. 컬렉션에 대한 표현은 복수로 사용.

12. 컨트롤러 이름으로는 동사나 동사구를 사용한다.

13. 경로 부분 중 변하는 부분은 유일한 값으로 대체 한다.

14. CURD 기능을 나타내는 것은 URI에 사용하지 않는다.

15. URL Query Parameter 디자인, URI 커리 부분으로 컬렉션 결과에 대해서 필터링 할 수 있다.

EX) /Web-master?chapter=2

16. URI 쿼리는 컬렉션의 결과를 페이지로 구분하여 나타내는데 사용한다.

17. API에 있어서 서브 도메인은 일관성 있게 사용해야 한다.

18. 클라이언트 개발자 포탈 서브 도메인은 일관성 있게 만든다.

EX)https://dev-[ ].co.kr