apiDoc 入门
2024-08-28 15:53:43
网站
Install
npm install apidoc -g
Run
apidoc -i myapp/ -o apidoc/ -t mytemplate/
没有模板
apidoc -i myapp/ -o apidoc/
Demo
首先要有个myapp文件夹
里面有一个接口描述（ 详细描述见官网 ）
/**
* @api {post} /company/useList 获取公司员工列表
* @apiName PostCompany
* @apiGroup User
* @apiVersion 0.1.0
* @apiDescription 接口详细描述
*
* @apiParam {int} pageNum分页大小
*
* @apiSuccess {String} code 结果码
* @apiSuccess {String} msg 消息说明
* @apiSuccess {Object} data 分页数据封装
* @apiSuccess {int} data.count 总记录数
* @apiSuccess {Object[]} data.list 分页数据对象数组
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* code:0,
* msg:'success',
* data:{}
* }
*
* @apiError All 对应<code>id</code>的用户没找到 asdfasdf
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 404 Not Found
* {
* code:1,
* msg:'user not found',
* }
*
*/ /**
* @api {get} /company/useList 获取公司员工列表
* @apiName GetCompany
* @apiGroup User
* @apiVersion 0.1.0
* @apiDescription 接口详细描述
*
* @apiParam {int} pageNum分页大小
*
* @apiSuccess {String} code 结果码
* @apiSuccess {String} msg 消息说明
* @apiSuccess {Object} data 分页数据封装
* @apiSuccess {int} data.count 总记录数
* @apiSuccess {Object[]} data.list 分页数据对象数组
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* code:0,
* msg:'success',
* data:{}
* }
*
* @apiError All 对应<code>id</code>的用户没找到 asdfasdf
* @apiErrorExample {json} Error-Response:
* HTTP/1.1 404 Not Found
* {
* code:1,
* msg:'user not found',
* }
*
*/
运行
apidoc -i myapp/ -o apidoc/ 会生成一个文件夹apidoc，里面就是生成的接口页面
最新文章
- linux基本命令
- jquery选项卡
- 用CMake设置Visual Studio工程中预处理器定义值
- ATL开发 ActiveX控件的 inf文件模板
- base64 加密
- Jquery.validate.js表单验证插件的使用
- esper 事件引擎，各种事件类型示例代码
- 利用Jersey构建REST之入门实例
- 【转】C#通过Expression获取指定属性的名称
- 项目报错，tomcat中引起
- linux下查看已经安装的jdk 并卸载jdk
- log4e插件的安装和使用
- 中国剩余定理（CRT）与欧拉函数[数论]
- es6学习笔记--模板字符串
- 【转】 HDMI介绍与流程
- js·逻辑运算
- JavaScript基础要点
- [蓝桥杯]ALGO-95.算法训练_2的次幂表示
- std::string的find问题研究
- SqlServer Case when then用法总结