간단한, 정말 간단한 API 문서 만들기 October 25, 2019

간단하게 API문서를 만들어야 할 일이 생겼는데 만들어 본 적이 없어서 어떻게 해야할지 난감했다.

그래서 열심히 검색.

Swagger, Slate, Gitbook 등 API 문서를 위한 도구거나, API 문서 작성을 위해 활용할 수 있는 tool을 찾았다.

살펴보니 손에 익지 않아서 그런지 다들 배보다 배꼽이 큰 것 같은 느낌이 들었다.

그러던 중에 다음 글에서 간단한 포멧을 발견!

api 문서화, 좋은 예시

EXAMPLE.md

EXAMPLE.md를 기준으로 좀 더 간략하게 API 문서를 만들고 notion을 이용하여 공유했다.

노하우를 공유해주는 사람들, 자신의 문제 해결 과정을 공유해주는 사람들이 있어 참 고맙다.