소프트웨어 개발자/좋은 API, DB 설계하기

[좋은 API 설계하기] 한 페이지에 API 몇개?

yubi5050 2024. 1. 30. 23:28

 페이지 정보 - API 1개 vs 2개

한 페이지에 정보 내릴 때 몇 개의 API로 내릴 것인가

ex. 유저(A)의 ~ 데이터 (B) 목록 조회

 

API 1개

  • 유저(A)의 데이터(B)를 묶어서 내림
  • http 및 db 커넥션 감소, api 수 줄이는게 좋다.

 

API 2개

  • api는 페이지에 종속되면 안된다.
  • 한 가지 함수는 한 가지 기능만 담당하는 것 처럼, 하나의 API는 하나의 정보만 담당하는 것도 좋다.
  • 재사용성, 유지 보수에 좋다
  • API 이슈 있을 시 에러가 전파되지 않음 

 

설계시 고민할 부분

  • API 수를 줄이는 측면에서, 해당 부분이 성능이 그렇게 까지 중요한 부분인가?
  • 예로 관리자 서비스의 페이지 정보라면 성능보단 재사용성, 유지보수에 중점