[개발일기] 2021-12-29

최근 프로젝트를 진행하면서 느낀 문제점은 내가 어떠한 정보들을 문서화 하지 않는다는 것이다.

당장 나만 해도 몇 달전, 몇 주전 프로젝트만 해도 내가 어떤식으로 로직을 짰는지 기억이

나지 않아 어디에 무엇이 있는지 하나하나 찾아 가야 했다.

그래서 이번에 restful api를 통해 데이터를 보내는 부분을 api 문서화하여 만들기로 하였다.

api 문서화를 하는데에 많은 프로그램들이 있었지만 나는 만드는 프로젝트 내에

직접 api 문서를 만들기로 하였다. 따로 프로그램을 사용한 것이 아니라서 직접적으로

연결 상태와 값을 주고 받지는 못하지만 내가 로직내에서 직접 값을 보내서 확인하기에

이 부분은 크게 문제가 되지 않을 것 같다. 그래서 어떤 부분에 어떤 api를 보냈는지를

명확하게 알 수 있도록 프로젝트 내에 api를 문서화하여 만들기로 했다.

사실 이러한 방법이 괜찮은 방법인지는 모르지만 내 스스로 api를 문서화하여

보기 쉽게 만든다는 점에서 의의를 두기로 하였다.