weblgdong/apidoc

apidoc生成Web API文档

官网 http://apidocjs.com/

预览 http://apidocjs.com/example/

temp https://github.com/apidoc/apidoc

使用方法

安装apidoc

npm install -g apidoc

生成api文档

apidoc -i docs/ -o apidoc/ -t template/

目录

├── apidoc 输出文件
├── docs 输入/源目录名
├── template 模板文件
├── apidoc.json apidoc配置文件

注意事项

apidoc测边栏显示中文(@apiGroup 用中文分组 显示乱码(____))

如果在apiGroup用中文,导航的测边栏会显示乱码。
解决方法：
修改 api_group.js
找到apidoc npm目录下的 workers/api_group.js
默认在 C:\Users\Administrator\AppData\Roaming\npm\node_modules\apidoc\node_modules\apidoc-core\lib\workers
83行 注释和删除.replace(/[^\w]/g, '_');

 group = group//.replace(/[^\w]/g, '_');