📔

기획서 - 하하

멋진 api 명세 문서를 만들고 싶어서 생각하였습니다.

백엔드 개발자 취업준비생 A는 오늘도 열심히 개발한다. 기계적으로 테스트 코드를 작성하고 swagger 나 restdocs 와 같은 툴로 api documentation 를 만든다.

완성된 api 명세를 보는데 너무 맘에 들지 않는다. 너무 못생겼다.

그 와중에 이런 잘 정리된 api 명세를 보니 따라 만들고 싶어 졌다.

하지만 A씨는 무능한 백엔드 취준생일 뿐이다. A 씨는 프론트엔드를 모른다. A 씨는 이런 멋진 명세를 제작할 수 없어 절망 중이다.

하지만 A씨는 ApiSpecGen 서비스를 만나 자신이 무지하게 생성한 .adoc 파일 혹은 swagger yaml 파일을 제공하여 멋진 명세 문서를 얻고 기뻐하게 되었다.

프론트엔드 개발자 B는 백엔드 개발자 C에게서 API document 를 받아보자 마자 한숨이 나온다. 툴로 생성된 명세에 너무 번잡한 정보들이 boiler-plate 하게 담겨있어서 화가난다.

B는 C에게 ApiSpecGen 을 알려주고 앞으로는 이를 통해 명세를 조금 다듬을 것을 요구한다. C는 예시들을 확인하고 자신의 개성을 듬뿍 담은 아름다운 document 를 B에게 제공할 수 있게 되었다. B와 C는 모두 기뻐하게 되었다.

사용자는 로그인할 수 있다.

메인페이지에 이미 만들어진 예시 document 들의 메인 페이지가 나온다.

document 생성을 할 수 있다.

상세 조회에서 같은 테마로 document 를 생성할 수 있다.

생성이 완료되면 document 의 공유 여부를 선택한다.

무료회원은 무조건 공유해야한다.

유료회원은 공유하지 않아도 된다.