API 디자인할 때 고려해야 할 사항

Posted on Edited on In , Word count in article: 127 Reading time ≈ 1 mins.

API 설계 할 때 고려해야 할 점은

Caching

반복되는 요청을 빠르게 처리하기 위해서는
Redis 나 ElasticCache 를 사용해야 한다

API 문서

API 문서를 제공해서 API 를 사용하는 사람들이 쉽게 사용할 수 있어야 한다.
업데이트 할 경우에 문서도 같이 업데이트 해줘야 한다

JSON 사용하기

Return 값은 JSON 을 반드시 사용한다. 평문으로 보내지 않는다.

복수형 이름을 사용하기

1
2
GET : /posts/1
POST : /posts

마지막에 슬래시(/) 사용하기

1
2
3
4
5
//Bad
POST : /posts

//Good
POST : /posts/

401 403

401 에러와 403 에러의 차이점 숙지

  • 401 Unauthorized : 인증 실패
  • 403 Forbidden : 인증은 성공되었으나 리소스에 접근할 권한이 없는 경우

데이터에 대한 페이징 처리

데이터가 많아질 것을 대비해서 페이징 처리를 해서 API 를 설계할 것
전체 데이터를 호출하는 API 는 데이터가 많아질 수록 성능저하가 발생됩니다

속성명은 CamelCase 를 사용할 것

_ 나 대문자는 사용하지 말 것