API 설계에 대해서 질문있습니다

Question

프로젝트를 진행하면서 API를 어떻게 만들어야 할 까 고민이 있는데{ &#34;event&#34;: { &#34;id&#34;: 1, &#34;createdBy&#34;: 1, &#34;title&#34;: &#34;title&#34;, &#34;content&#34;: &#34;content&#34; }, &#34;application&#34;: [ { &#34;applicationId&#34;: 1, &#34;applicationTitle&#34;: &#34;applicationTitle&#34;, &#34;applicantName&#34;: &#34;applicantName1&#34;, &#34;progressStatus&#34;: &#34;APPLY&#34; }, { &#34;applicationId&#34;: 2, &#34;applicationTitle&#34;: &#34;applicationTitle&#34;, &#34;applicantName&#34;: &#34;applicantName2&#34;, &#34;progressStatus&#34;: &#34;REJECT&#34; } ] }현재 위와 같이 되어있는 상태입니다이벤트 정보(event)참여 신청서 정보(application.applicationId, application.applicationTitle) 참여자 정보(application.applicantName)참여 정보(application.progressStatus)우선은 화면에 맞게 필요한 정보를 전부 서버에서 가공해서 제공을 해주고 있는데 이게 아니라 4가지를 각각 별도의 API를 통해서 가져오도록 하는게 맞을지 고민입니다팀원들과 말했을 때는 별로 큰 어려움이 안들기 때문에 해주면 되죠라고 나왔는데 이게 맞나?..라는 생각입니다 지금이야 작은 프로젝트고 MSA도 아니고 하나의 프로젝트에서 전부 관리가 되는데 정말 정말 나중에 MSA로 분리가 된다면 이 API는 어디에 들어가야 하는거지라는 생각도 들기도 하고요&#34;event&#34;: { &#34;id&#34;: 1, &#34;createdBy&#34;: 1, &#34;title&#34;: &#34;title&#34;, &#34;content&#34;: &#34;content&#34; } --- &#34;application&#34;: [ { &#34;applicationId&#34;: 1, &#34;applicationTitle&#34;: &#34;applicationTitle&#34;, &#34;applicantId&#34;: 1, &#34;applicationInfoId&#34;: 1 }, { &#34;applicationId&#34;: 2, &#34;applicationTitle&#34;: &#34;applicationTitle&#34;, &#34;applicantId&#34;: 2 &#34;applicationInfoId&#34;: 2 } ] --- &#34;applicant&#34;: [ { &#34;applicantId&#34;: 1, &#34;applicantName&#34;: &#34;applicantName1&#34;, }, { &#34;applicantId&#34;: 2, &#34;applicantName&#34;: &#34;applicantName2&#34;, } ] --- &#34;applicationInfo&#34;: [ { &#34;applicationInfo&#34;: 1, &#34;progressStatus&#34;: &#34;APPLY&#34;, }, { &#34;applicationInfo&#34;: 2, &#34;progressStatus&#34;: &#34;REJECT&#34;, } ]이런 식으로 전부 분리해서 프론트에서 알아서 필요한 정보를 가져다가 사용하는게 맞지 않을까? 라는 생각인데 다른분들의 생각은 어떤지 궁금합니다

장독깨기 · Accepted Answer

위 방식으로 하셔야죠.하나의 서비스는 하나의 API 로 관련 정보를 전부 제공한다 생각하는 것이 좋겠습니다.저걸 API 로 쪼개 버리면 서비스가 아니 될 거 같지 않은가요. ㅎ저 API 를 이용하는 사용자들에게 문서로 관련 정보를 제공 한다 생각해보면요,어떤 서비스를 이용하려면 API1, API2, API3 을 조합해서 사용하세요 이렇게 됩니다.많이 좀 이상해보입니다. 우리끼리 약속해서 알아서 할거니 상관없다 이런 식이면 좀 곤란하겠죠. :)

집킨 · Answer

경험상 그냥 한번에 주는게 더 좋았습니다그에 따른 유지보수성은 컨트롤러에서만 희생하면 되거든요대신 성능과 리소스 효율은 3배 좋아지죠단, 응답 데이터의 크기가 크다면 얘기는 좀 달라지긴 합니다참고로 보통 MSA에선 클라이언트가 호출하는 public API 서버에서 각 서비스의 데이터를 취합해서 응답합니다파사드 패턴이죠

김을동 · Answer

api 분리하고 분리된 애들을 한번에 받는 api도 있으면 해결~

초무쿤 · Answer

논리적으로 명확한 기능별로 분리하고 프런트에선 필요한 정보들 각각 조회하는게 재사용성이나 API라는 개념에는 맞을거 같은데요.필요한 정보들을 Promise.all 같은거로 한번에 묶어서 조회할수도 있으니깐요.기능위주가 아니라 화면 하나하나에 맞춰서 개발하면 기하급수적으로 늘어나면서 API라는 이름이 무색해질듯 해요.

API 설계에 대해서 질문있습니다

4개의 답변

Q&A 목록