apidoc用了一段时间，虽然功能比较简单，但对快速整理工作中常用的接口api还是非常方便的，能满足日常查阅就行。官网：http://apidocjs.com/

Install

如果没有安装npm的，需要先安装

1
npm install apidoc -g

Setting

新建工作目录和输出目录

1
2
mkdir workplace
mkdir doc

设置apidoc.json配置项

1
2
3
4
5
6
7
{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "title": "Custom apiDoc browser title",
  "url" : "https://api.github.com/v1"
}

apidoc.json与workplace、doc在同一级目录下

Run

1
apidoc -i workplace/ -o doc/

workplace/是源文件目录，doc/是渲染出的静态文件目录，文件名可自己定，当workplace中没有工作文件时，会提示error: No files found. { Path: ‘workplace/‘ }