🔙뒤로가기

URI란?

URI(Uniform Resource Identifier)는 인터넷에서 자원을 식별하는 데 사용되는 고유한 문자열이다. RESTful API에서는 자원에 대한 액세스와 조작을 위하 URI를 사용한다. 효과적인 URI 설계는 API를 쉽게 이해하고 사용할 수 있도록 돕는다.

다음은 URI 설계 원칙에 대한 몇 가지 핵심 사항이다.

핵심 URI 설계 원칙

1. 명사 사용 URI는 자원을 나타내야 하므로 명사를 사용해야 한다. 동사를 사용하는 것을 피하고, 대신 HTTP 메소드(GET, POST, PUT, DELETE 등)를 사용하여 동작을 표현하라.
2. 복수형 사용 자원의 집합을 표현할 때는 복수형 명사를 사용해야 한다. 예를 들어, 사용자를 나타내는 자원의 경우 /users와 같이 복수형을 사용한다.
3. 계층 구조 표현 URI에서 계층 구조를 표현하기 위해 슬래시를 사용해야 한다. 예를 들어 특정 사용자의 주문 내역은 **/categories/{category_id}/subcategories**와 같이 표현할 수 있다. (이 예시에서는 계층 구조가 “카테고리>하위 카테고리” 로 표현되었다.)
4. 자원 간 관계 표현 관계를 나타내려면 URI를 중첩하여 사용해야 한다. 예를 들어, 특정 사용자가 속한 그룹을 표현하려면 /users/{user_id}/group 와 같이 표현할 수 있다. (이 예시에서는 "사용자와 게시물"이라는 서로 관련 있는 자원 간의 관계가 표현되었다)
5. 소문자 사용 URI에서는 소문자를 사용하는 것이 좋다. 대소문자 구분이 있기 때문에 대문자를 사용하면 혼란을 줄 수 있다.
6. 케밥 케이스 사용 URI에서 단어를 구분할 때는 언더스코어 _’대신 하이픈 -을 사용하는 것이 좋다. 이는 검색 엔진 최적화(SEO)와 가독성에 도움이 된다.
7. 필터링 및 정렬 쿼리 문자열을 사용하여 자원에 대한 필터링, 정렬, 페이징 등을 지원해야 한다. 예를 들어 /users?sort=name&limit=10&page=2 와 같이 사용할 수 있다.
8. 명료하고 간결하게 가능한 간결하고 명료한 URI를 사용해야 한다. 불필요한 단어나 길이를 줄여 가독성을 높이고, 이해하기 쉬운 구조를 만드는 것이 중요하다.