백엔드는 api를 만들고 프론트엔드 분들께 어떻게 api를 제공하나요?

Question

안녕하세요.현재 프론트엔드로 웹과 백엔드로 서버를 둘다 하고있으며,서버 api를 제작할때 제가 담당한 웹페이지 뿐만 아니라 다른 프론트엔드 분들이 필요하다고하는 api들도 같이 만들고있습니다.그런데 다른 경력직 프론트엔드 분들과 이야기하다보니 왜 postman을 주냐고 하는 질문을 하셨습니다.그래서 그럼 api 어떻게 전달하냐고 물어보니, 따로 정리해서 입력값과 결과값 또는 실패값만 주지 postman을 직접주지 않는다고 하더라고요.제가 우선 현재는 postman으로 api주고 그 밑에 example로 결과값하고 실패시 나오는 코드 예시들을 다 같이 주긴하는데,제가 하는 방식이 잘못되었는지 궁금합니다.스타트업에 신입으로 들어갔으며, 기존 분이 이렇게 하셨어서 그냥 따라하면서 하는 중이라, 소통을 어떻게하는지 잘 모릅니다.읽어주셔서 감사합니다.

신입개발자n · Answer

명세서랑 포스트맨을 같이주면 좋을거같은데요?~ 아니면 Swagger도 있구요

SunnySky · Answer

문서화 하거나 스웨거 제공하면 깔끔합니다

더미 · Answer

스웨거를 주고보통 포스트맨은 본인이 테스트하려고 쓰는거죠.

와우아이 · Answer

신입개발자n, SunnySky, 더미 답변주셔서 감사합니다.

개발잡부 · Answer

포스트맨 자체를 명세서로 사용하는 경우도 많은데 흠...?

ZERO개발자 · Answer

api문서,Swagger

푸우아빠 · Answer

swagger로 줍니다.

Brian.P · Answer

해당 프엔이 포스트맨을 쓸 줄 모름.. 생각해보니 쓸 줄 아는데 따로 문서화해야 될 이유가 없음그냥 늙은 프론트엔드가 아닐까 싶습니다. Swagger 를 언급했다면 모를까 그냥 경험해본 환경이 그래서 그럴수도 있구요 아니면 전달 주실 때 테스트방법이나 헤더 설정같은게 자동으로 다 되게해서 버튼 이거 누르면 되요 이렇게 알려주시는 방법도 있습니다.

chytonpide · Answer

포스트맨 ,성공 실패 example 로 제공하는 서비스 엄청 많습니다. swagger 사용하면 다른 메타정보도 같이 줄수 있어서 좋긴한데 사실 엄청 복잡한 api 아니면 굳이 쓸 필요없고, postman 으로 충분합니다.

으헝러헝헝 · Answer

저도 포스트맨 줍니다 거기에도 문서작성하고 다 작성할 수 잇읍니다.상관없읍니다. 포스트맨 주면 오히려 예제코드까지 볼수잇으니프론트엔드단에는 개꾸르딱인데 그분은 너무하네요

우나마나 · Answer

Swagger,SpringRestDoc등 활용해서 API 규격 문서 자동화해서 일반적으로 클라이언트에 제공 많이하구요뭐 그게 불편하면 엑셀이나 컨퍼런스,노션등에 문서화해서 제공해도 되구요 방법은 많죠...클라이언트랑 사수 or 팀장님이랑 앞으로 api 제공 어떻게 하는게 좋을지 논의하고 그 방식대로 진행하는게 좋을 것 같네요

백엔드는 api를 만들고 프론트엔드 분들께 어떻게 api를 제공하나요?

11개의 답변

기타 목록