apidoc ----api文档生成工具的使用
来源:互联网 发布:网络信息安全上岗证书 编辑:程序博客网 时间:2024/04/28 23:36
apidoc 是一款api文档生成工具,简单易用。apidoc会生成一个html,建议同时配置在服务器上,例如通过Nginx配置静态资源,供多人协作浏览,配置好之后,每次修改了api,只需要一行命令即可完成文档更新。
一、安装
$npm install apidoc -g
二、配置(可选)
在项目目录下添加 apidoc.json 文件
ex:{
“name”: “example”, //项目名称
“version”: “0.1.0”,
“description”: “apiDoc basic example”,
“title”: “Custom apiDoc browser title”,
“url” : “https://api.github.com/v1” //一般为域名
}
三、基本格式
在相关文件内加入注释,ex:
/**
@api {get} /user/:id Request User information
@apiName GetUser
@apiGroup User
*@apiPermission Web
*
- @apiParam {Number} id Users unique ID.
*
@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname Lastname of the User.
@apiSuccessExample Success-Response:
HTTP/1.1 200 OK
{
“firstname”: “John”,
“lastname”: “Doe”
}
*/
三、基本命令
ex:
$ apidoc -i controller -o doc
controller:输入目录,添加了上面的api注释的目录
-o :文档输出目录
四、使用
打开doc目录下的index.html文件,即可看到刚刚生成的api文档。
demo
如果配置到服务器上,使用方法同理。
- apidoc ----api文档生成工具的使用
- 【推荐】apidoc api文档生成工具的使用(mac)
- Web API文档生成工具apidoc 的使用步骤
- Web API文档生成工具apidoc
- Web API文档生成工具apidoc
- 使用apidoc生成restful-api文档:安装nodejs+npm+apidoc
- apidoc 生成api文档
- 使用apidoc 生成Restful web Api文档
- 使用apidoc 生成Restful web Api文档
- 使用apidoc 生成Restful web Api文档
- ApiDoc 自动生成API文档
- 使用apidoc自动生成rest风格api接口文档
- apidoc 安装与使用示例生成 Api文档
- 使用apidoc生成接口文档
- apidoc 生成Restful web Api文档
- apidoc 生成Restful web Api文档
- api文档生成器apidoc的安装和使用
- apidoc使用教程-编写漂亮的api文档
- Java
- ros-更新源
- CPU的RISC和CISC架构的区别
- 会话技术cookie和session,JSP,EL,JSTL
- 异常解决篇:redis使用时一段时间后会报出RedisConnectionFailureException: java.net.SocketException: Broken pipe;异常
- apidoc ----api文档生成工具的使用
- 155.PHP中“==”运算符的安全问题
- Web前端高效开发最佳实践总结一:前端开发综述
- JavaScript词法结构
- Java线程池
- 自旋锁、信号量、互斥锁的介绍和区别
- [偏相关分析]偏相关系数计算及假设检验
- ISIS-P2P网络的LSDB更新
- Java并发编程:ConcurrentModificationException异常原因和解决方法