API 문서 만들기 Open Source

공식사이트  : http://apidocjs.com/

DEMO : http://apidocjs.com/example/

서버 요구사항 : npm, node js 설치 되어있어야 함.

• 문서 생성 순서 

1. API문서 양식을  원하는 언어로 양식을 만들어 놓는다. (여기서는 .js) 로 생서
2. 문서 생성 명령어 cmd 에서  실행

ex ) $ apidoc -i myapp/ -o apidoc/ 

OR 

$ apidoc -i myapp/ -o apidoc/ -t mytemplate/

설명 : 

myapp  -> 내가 작성한 api 양식 문서가 담겨있는 폴더

apidoc  -> 생성되는 api 문서가 저장 될 폴더 (실제로 문서가 보여지는 곳, 호스팅으로 연결할 때에는 가상호스트의 document root 가 이곳이어야 한다)

mytemplate -> 생성되는 문서의 템플릿 ( 디자인 , node_modules/apidoc/template 폴더를 참고 )