ApiDoc 自动生成API文档
2017-12-15 13:56
225 查看
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
可以使用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
相关文章推荐
- apidoc 自动生成api文档
- 如何使 WebAPI 自动生成漂亮又实用在线API文档
- 最近使用springfox(swagger)自动生成api文档时问题心得
- springmvc集成Swagger自动生成api文档
- 利用beego自动生成带数据库基本CRUD的API和自动化文档
- SwaggerUI自动生成API文档(SwaggerUI+SpringBoot)
- java自动生成文档,自动生成API,你不知道的Eclipse
- apidoc接口文档自动生成工具
- 修改Xcode自动生成的文件注释来导出API文档
- apidoc 生成api文档
- Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- apidoc ----api文档生成工具的使用
- app后端开发二:API接口文档自动生成工具
- java服务器使用swagger自动生成API文档
- jsdoc注释规范工具(使用 JSDoc 3 自动生成 JavaScript API 文档)
- Spring MVC 集成 Swagger,API文档自动生成~
- 自动生成api文档
- 【开源】AspnetCore 2.0 自动API文档生成组件,支持protobuffer
- 使用GTK-DOC自动生成API文档