우당탕탕 우리네 개발생활

API문서는 개발팀끼리의 협업에 있어 반드시 필요합니다. API문서가 존재하지 않는다면, API를 사용해야 하는 당사자가 매번 직접 코드를 분석하여 필요한 스펙을 알아내야 할지도 모르겠습니다.  저는 백엔드개발자로서 API문서를 여러번 작성해 봤습니다. Google Docs와 OpenAPI를 통해 작성을 해봤었는데 OpenAPI에 더 매력을 느끼게 되었습니다. Google Docs는 무난하고 익숙했습니다. 어려서부터 '한글'을 주로 사용하면서 docs와 비슷한 환경에서의 문서작성을 해본 경험이 있었기 때문에 프로그램 내 도구들을 사용하는데 어려움이 없었습니다. 하지만 다목적 프로그램이니 만큼 형식이 없어 API문서의 필요한 요소들을 전부 만들어야 하는 부분이 큰 단점으로 여겨졌습니다. 실제로 제가 Ato..