좋은 REST API 는 어떻게 설계되는가? 9가지 특징

좋은 REST의 9가지 특성에 대해 설명한 글

9가지 토픽이라 다 한번에 가져오면 양이 많아질 것 같아서 토픽만 뽑아봤다.

시간 남으면 하나씩 주제 잡고 번역해서 올리려고 하는데 일단 9가지는 다음과 같다

 

json 형식 잘 맞춰서 통신할 것 (주고 받고 둘다)

앤드포인트 경로에 동사대신 명사를 사용할 것

콜렉션의 이름은 복수명사로 지을 것

API 엔드포인트 nesting을 할 논리적인 구조인지 생각

쓸데 없이 커스텀 에러 만들지 말고 표준 에러를 통해서 에러 처리를 할 것

필터링,정렬,페이지네이션 구현할 것

보안을 고려하여 설계할 것

캐시 데이터를 적극 활용하여 성능에 신경쓸 것

적절한 API 버전관리의 중요성

 

node JS 예제로 되어있으니 원문을 읽어보는것이 좋을듯

출처 : https://stackoverflow.blog/2020/03/02/best-practices-for-rest-api-design/