ApiDoc 自动生成API文档
来源:互联网 发布:java多线程模拟多用户 编辑:程序博客网 时间:2024/04/28 20:46
1、确认已经安装node.js
可以使用npm命令
否则要先安装node
2、安装apidoc
命令行运行
npminstall apidoc -g
3、在项目的当前目录下编写一个脚本genAPIdoc.bat
内容为
apidoc -o ../doc/apiDoc/
Pause
(将生成的API文档 -o 输出output到上层文件夹的doc/apiDoc下)
4、配置(apidoc.json)
{
"name": "js_iot_emergency_command",
"title":"emergencyCommandAPI",
"description":"emergencyCommandAPI接口文档",
"url" : "http://api.demo.com",
"version": "0.1.0"
}
5、配置完成之后,在命令行下进入项目目录,运行脚本文件genAPIdoc.bat
即可在doc/apiDoc下自动生成API文档
打开index.html
阅读全文
0 0
- ApiDoc 自动生成API文档
- apidoc 生成api文档
- 使用apidoc自动生成rest风格api接口文档
- 使用apidoc生成restful-api文档:安装nodejs+npm+apidoc
- 使用apidoc 生成Restful web Api文档
- Web API文档生成工具apidoc
- apidoc 生成Restful web Api文档
- apidoc 生成Restful web Api文档
- Web API文档生成工具apidoc
- 使用apidoc 生成Restful web Api文档
- apidoc ----api文档生成工具的使用
- 使用apidoc 生成Restful web Api文档
- apidoc接口文档自动生成工具
- apidoc生成resuful文档
- 【推荐】apidoc api文档生成工具的使用(mac)
- Web API文档生成工具apidoc 的使用步骤
- apidoc 安装与使用示例生成 Api文档
- 使用apidoc生成接口文档
- 小程序---仿百思不得姐
- Android四大组件—Service
- 添加下拉列表
- Linux 中对标准输入进行键盘事件监听
- javaweb项目编写webservice接口
- ApiDoc 自动生成API文档
- Struts2标签库和OGNL
- 这次我要为程序员说话
- gcc编译C++程序
- pyinstaller将Python脚本打包成可执行程序
- 从JBOSS启动的问题谈及JBOSS中jar的加载顺序
- PHP冒泡排序
- iOS基础积累
- linux服务器重启后,自动重启web项目