API 명세를 작성해야한다!

api 명세를 작성해야한다.

얼마 전 글로디 팀 소통방식을 놓고 회의가 있었다.

나는 백엔드와 협력해서 플젝을 해본 적이 없었다. 최근에 진행하고 있는 캡스톤 프로젝트도 혼자 클라이언트를 모두 구현해야했다. 그래서 그냥 파이어베이스로 백단을 처리해서 구현하고는 했었다. 어쨋든 이번에 백엔드 분과 협력을 해서 개발을 해야하는데, 협업방식에 약간 문제점이 있었다고 한다.

백이 코드를 수정해서 서버에 올리고 돌린다음
명세를 작성해서 프론트에 전달하면 프론트는 그 명세대로 작동하나 확인해야했다.

그러다 보니까 문제가 생기면 이거 고쳐주세요 말씀을 드리다보니 그걸 듣고 또 고치고 그 사이에 딜레이가 발생하고.. 그러다보니 개발에 정체가 생겼었다.

하여 현직자 PM 분과 다같이 만나서 문제진찰을 받아서 그 부분이 문제라는 것을 지적받고, 백에서도 프론트의 코드를 받아서 스스로 테스트 해보며 완성도 있는 api를 제공해야하고, 프론트도 필요하지만 구현이 되어있지 않은 api에 대해서는 명세를 작성할 수 있어야하고 이게 중요하다고 하셨다.

그래서 어디에 옮겨야할까 싶다가 노션과 구글 스프레드시트 이야기가 나왔는데 일단 구글 스프레드 시트로 해보자고 결정이 났다.



문제는... 지금까지 구현된 api에 대한 명세를 수작업으로 옮겨야하고, 뭔가 새로 작성해서 추가한다고 하더라도 스웨거에서 보는 만큼 깔끔해야한다는 것인데.. 그렇지가 못한 것 같다.


흐음.


아 또 그리고 하나
각자 어디를 개발하는지 스프린트로는 한계가 있는 것 같다. 그걸 카톡으로 물어보기에는 아직 그렇게 친분이 있는 것도 아니고 친분이 있다고 해도 불편할수도..

그래서 이부분에 대해서는 트렐로를 만들어서
기획팀, 개발팀-프론트, 개발팀-백, 다른 홍보팀 분들 이렇게 해서 라인을 하나씩 해서 진행해보는게 어떨까 싶어서 제안서를 작성해보려고 한다.

뭔가 협업관련 시스템들이 정비되는 것 같아서 뭔가가 되어가는 듯한 이 기분이 좋다.

팀 메신저- 두레이
팀 작업현황- 트렐로
개발팀 api 및 스키마 공유 - 스프레드시트 or 노션..

노션은 무료 이용량 다 채우면 비싸다는걸 최근에 알아서 조금 망설여지는.. 흑

---

다음은 구글 스프레드 시트에 옮긴 api 명세의 일부다
(엥 근데 구글 스프레드시트에서 보는 것보다 왜 여기서 보는게 깔끔해보이지..
역시 엑셀보다 셀이 없는게 더 깔끔해보인다)

apply-api ( Apply Api )
POST	/api/v1/groups/{groupId}/apply
Parameters
Name	Description
groupId - Integer	groupId
request - object	request
	{ "introduce": "string", "reason": "string" }
userId - Integer	userId
	{}
Responses
Code	Description
200	OK
	{ "applyId": 0 }
201	Created
401	Unauthorized
403	Forbidden
404	Not Found