URI 설계 패턴

1. URI (Uniform Resource Identifier)

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

파일다운을 예로

요청 : http://www.fastcampus.co.kr/resource/sample/1

응답: fastcampus.pdf 또는 fastcampus.pdf

2. URL (Uniform Resource Locator)

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

요청 : http://www.fastcampus.co.kr/fastcampus.pdf

URL은 URI의 하위 개념

 

URI 설계원칙 (RFC-3986)

• 슬래시 구분자 ( / )는 계층 관계를 나타내는세 사용한다.
• URI 마지막문자로( / )를 사용하지 않는다.
• 하이픈( - )은 URI의 가독성을 높이는데 사용한다.
• 밑줄 ( _ )은 사용하지 않는다.
• URI경로에는 소문자가 적합하다.
• 파일 확장자는 URI에 포함하지 않는다.
• 프로그래밍 언어에 의존적인 확장자를 사용하지 않는다.
• 구현에 의존적인 경로를 사용하지 않는다.
• 세션 ID를 포함하지 않는다.
• 프로그래밍 언어의 Method명을 이용하지 않는다.
• 명사에 단수형보다 복수형을 사용해야한다. 컬랙션에 대한 표현은 복수로 사용
• 컨트롤러 이름으로는 동사나 동사구를 사용한다.
• 경로 부분중 변하는 부분은 유일한 값으로 대체한다.
• CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.
• URI Query Parameter디자인 - URI퀘리 부분으로 컬렉션 결과에 대해서 필터링 할 수 있다.
• URI 쿼리는 컬렉션의 결과를 페이지에 구분하여 나타내는데 사용한다.
• API에 있어서 서브 도메인은 일관성 있게 사용해야 한다.
• 클라이언트 개발자 포탈 서브 도메인은 일관성있게 만든다.