백엔드 신입이 할 수 있는 API 리뷰 방법에 대해 가이드를 부탁드립니다.

Question

스타트업에 2개월째 근무중인 신입입니다.회사의 완전 핵심!!! API 하나 분석을 진행했고, 내일 팀장님께 리뷰를 할 예정인데요.API에서 호출하는 메서드나 기능, 관련 DB 등은 코드에서 알아낼 수 있는만큼 최대한 세세히 정리해서 나열을 마쳤지만직접 대면으로 하는 API 리뷰는 어떤 식으로 하면 좋을지 여쭤보고 싶어서 글을 작성합니다!보통 API 분석 후 리뷰라면, API가 호출됐을 때 경우에 따라 어떤 로직이 동작하는지에 대해서만 설명하는 정도가 평균일까요??여기에서나마 찡찡대자면...팀장님께서는 API내부에서 경우 별로 진행되는 큰 흐름에 대해 설명하면 된다고 하셨지만해당 API가 하는 일이 굉장히 방대하고 처리하는 로직이 매우 복잡하고 세세하며 특정 경우들을 꼬집기에는 분리가 명확하지 않고 조금조금씩 애매한 경우가 꽤 많습니다.스타트업답게 가독성도 정말 좋지 않고 네이밍도 문맥에 전혀 맞지 않구요.필요없거나 쓸모없는 처리도 굉장히 많아서 완전한 파악이 너무 어렵네요 하하당연히 기본 몇 천줄 되는 코드이기 때문에 어떻게 해야 명확하게 설명할 수 있을까 더 막연한 것 같습니다.물론 너무 어렵게 생각하고 있는 것도 알고 제가 너무 완벽하려고 한 거일수도 있지만.. 그래도 첫 리뷰라 걱정이 앞섭니다 ㅎㅎ얼른 글 쓰고 다시 코드 보러가야해서 좀 횡설수설하게 쓴 것 같지만 소중한 의견 부탁드리겠습니다!!!

leon808 · Accepted Answer

보통 대략적으로 그린 순서도 같은 자료랑 같이 준비해서 설명드리지 않나요말로 땡치려면 거시적으로나 미시적으로나 파악을 잘해서 안 놓치고 말도 잘하시거나아니면 이전에 개발로서 파악 능력을 입증을 하신적이 있어야 할거에요저도 처음에 비슷하게 레거시 php 분석 후 java 마이그레이션 업무를 받았었는데말로 설명 잘 못하고 해서 도식도 그려도 건넘은게 있다면서 깨지고 혼났어요그래도 도식도 완성 후에 OK 받고 이후 마이그레이션 결과물로 인정 받고 다른 업무 몇 개 쳐낸 이후에는 이후로는 파악 능력을 매번 입증할 필요 없이 전권을 맡겨주시더군요 앞으로의 개발에 있어서 중요한 분수령이니 화이팅입니다

백엔드 신입이 할 수 있는 API 리뷰 방법에 대해 가이드를 부탁드립니다.

1개의 답변

Q&A 목록