210427_TIL(First Project 2일차)

✅API 문서 작성

어제 정했던 아이디어 부분에 어떤 요청이나 응답이 필요한지 생각해보고, 팀원들과 같이 추가했다.

API 문서는 gitbook을 이용해 만들었다.

API 문서를 팀원들이랑은 처음 작성해봤는데, 생각보다 엄청 엄청 중요한 과정이라는 걸 조금 많이 느꼈다.

처음에 API 작성을 하기 전에 "플로우 차트나 다이어그램이 있었으면 더 작성하기 편하겠다"라는 생각을 많이 했다.

프로젝트를 하기 전에 작성해야 할 SR(Software Requirement) 과정이 얼마나 중요한지 깨닫는 시간이었던 것 같다.

나중에 API 문서가 수정돼야 할 경우 조금 많이 어려움을 얻을 것 같다.

처음에 잘 작성을 해야 작업을 할 때 문제없이 잘 진행될 것 같다.

일단은 잘 작성한 것 같아 좋고, 요청과 응답을 정해놓으니 오히려 편하다.

 

🍒More Study

---

✅Task카드 만들기

✅Jenkins 공부하기