RESTful API

• API 시스템을 구현하기 위한 아키텍처 중에 가장 널리 사용되는 형식
• REST 특징을 지키면서 API를 제공한다.
• 타 아키텍처 대비 가장 좋음

웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고 그 리소스에 대한 행위를 HTTP method로 정의하는 방식

장점: self-descriptiveness, 그 자체만으로도 API의 목적이 쉽게 이해가된다.
단점: 표준규약이 없어, 안티패턴으로 작성되는 경우가 흔함

RESTful API 설계 규칙

• URI에는 HTTP method가 포함되면 안된다.
• URI에는 동사가 포함되서는 안된다.
• 파일의 경우 파일 확장자를 URI에 포함시키지 않는다.
• URI는 /구분자를 사용하여 계층 관계를 나타내는데 사용한다.
• URI 마지막 문자로 /를 포함하지 않는다.
• 불가피하게 URI가 길어지는 경우 -을 사용하여 가독성을 높인다.
• _를 사용하지 않는다.
• URI 경로에는 대문자 사용을 피하도록 규정하고 있다.

path parameter vs query parameter

query parameters

• GET parameters라고 하기도 한다.
• 주로 데이터를 조건으로 거르거나(filtering), 특정방식으로 정렬하거나(sorting), 검색(searching)하는 경우에 활용

path parameters

• 리소스를 식별하려고 할 때 경로 변수를 사용한다.

GET/product/3 vs GET/products?id=3

Best Pratice : Query parameters -> Filtering, Sorting, Searching