[생각정리]API 실무 개발 느낀점, 팁

지금까지 몇번의 API 개발을 진행하면서 느낀점과 팁을 간단하게 작성해보려고 한다.

개발적인 팁이라기보다 실무적인 팁이라는 점..(개발적인 팁은 고수들의 블로그에..)

 

---

 

1.무슨 API를 개발?

 

외부업체에서 쿠폰발행 연동을 해달라고 하였다. 외부업체 쇼핑몰에서 구매자가 구매 후, 우리쪽 API를 호출하여 우리 시스템에서 발행한다.

 

우리쪽으로 통신하는 API는 발행, 취소, 상태조회 등의 업무가 있었고, 외부업체쪽으로 통신하는 API는 쿠폰사용 또는 취소시 상태변경 API를 호출하여 외부업체에 쿠폰상태를 현행화한다. 이 때 우리 시스템에선 rabbitMQ를 통해 처리한다.

 

• 인바운드 통신 API : 쿠폰 발행, 쿠폰 취소, 쿠폰 상태조회
• 아웃바운드 통신 API : 쿠폰 상태 변경

 

사실 올해 상반기까지만 해도 리더(PM,PL)가 개발 이외의 역할은 다 해주었기 때문에 편하게 개발만 하면 되었다. 그러나 하반기 운영 서비스가 바뀌어서 새로 적응해야했다.(팀이 바뀌진 않았다)

 

새로 적응하는 과정에서 가장 어려웠던 점은 이전과 다르게 내가 주도적으로 많은 것을 해야했던 것이다. 서비스 및 시스템 특성상 수십개의 서비스를 관리해야하고 그러다보니 리더(PM,PL)도 주도적으로 개발, 운영을 겸해서 하고 있다.

 

그래서 리더가 주로 하는 역할을 개발자들이 분담해서 많이 하는 편이다.

 

개발자들 입장에서는 장단점이 될 수 있다. 

 

장점은..

• 커뮤니케이션을 통해 주도적으로 서비스 개발, 운영을 할 수 있음
• 개발 이외에 부동산 투자 공부도 하고 있기 때문에 커뮤니케이션 연습이 필요한 나한텐 장점
• 개발자로써 주도적으로 서비스를 손볼수 있음(?)

 

단점은..

• 개발 이외에 불필요한 시간들이 많이 든다. 특히 커뮤니케이션 중간 역할을 잘 못해주는 사람을 만나면 하루면 끝날 개발인데 이틀이 걸릴 수도 있다
• 좀 부담된다. 개발하는 부분에 대해 책임의 범위가 넓어진다.

뭐 이정도가 있을 것 같다.

 

 

 

2. 느낀점과 팁

 

몇 번의 개발과 이번 개발을 통해 느낀점과 팁을 간단히 작성해본다. 미래의 나야 같은 실수 하지마라..

• 외부업체와 연동 개발시 외부업체 개발자와 커뮤니케이션을 보통 직접 안 한다. 중간에 사업담당자, PM 등이 역할을 해준다. 사실 중간담당자가 역할을 해주기 때문에 추후 책임 문제가 있을 때 혼자 뒤집어 쓰지 않는 것인데 그만큼 문의사항 전달이나 중간역할이 느려지면 개발도 느려지게 된다. 그래서 아주 개발적인 문의사항이나 질문은 유선이나 메일등으로 다이렉트 문의를 하는 게 좋은 것 같다. 그 외의 범위는 가능하면 담당자분께 맏기는 것이 좋은듯..(개인의견)
• IP 오픈 관련된 작업은 가능하면 빨리 체크해서 진행한다. 특히 운영 IP쪽 오픈은 미리할 수 있으면 미리한다. 추후 갑자기 개발되서 운영테스트하다가 안 되는 경우가 있다..는 나...
  • 업체측 통신 URL로 IP추정해서 우리쪽 인바운드IP로 등록하면 안 된다. 추가 IP들이 있는 경우가 많다. 꼭 업체측에 물어봐서 등록할 IP를 전달받아야 한다.
• 사업담당자가 개발에 대해 잘 모르시는 경우가 대부분이신데, 위에 말한것처럼 아주 개발적인 내용을 문의드릴 때 다이렉트로 커뮤하기 싫으면 잘 정리 후 '그대로 보내주세요'라고 하자
• 규격서를 너무 믿지 않는다. 기본적으로 규격서를 보고 연동은 해야하지만...규격서대로 안 되는 경우들이 있다. 필수값이 아니라고 적혀있으나 필수값인 경우, 컨텐츠타입이 안 적혀 있어서 많이 쓰는 json요청했는데 x-www-urlencoded인 경우 등..
• 중간중간 리뷰를 진행해서 팀원들과 공유한다. 내가 산으로 갈 경우 잡아주는 역할을 한다.
• 노션같은 곳에 설계작성을 미리 해둔다. 항상 손부터 가는 습관은 안 좋은 개발 습관이라고 생각한다..가끔 너무 바쁠 때나 너무 간단한 작업은 스킵해도 되지만..
• 뇌피셜은 최고의 적이다...커뮤니케이션이 두렵거나 귀찮아서 그냥 '이건 당연히 이렇게 되겠지..'라고 하면 5개중 2번은 당연히 안 그렇게 된다(..) 나중에 배포전 수정량이 늘어날 수 있으니 미리미리 모르는건 질문하고 질문해서 깔끔하게 진행하는 게 좋은듯!