apidoc学习(接口文档定义取代word)
apidoc的安装,参考:https://blog.csdn.net/qq_36386771/article/details/82149848
生产文档,需要先编写一个apidoc.json对接口文档进行基本说明,在编写一些接口定义文档(采用js),然后运行命令,生成对于的html网页
demo案例:目录结构:
xxxx/apidoc_demo/apidoc.json 接口文档的总说明 xxxx/apidoc_dem/myapp/demo.js 接口文档具体接口的定义 xxxx/apidoc_dem/apidoc/ 用于存放生成的html文件在xxxx/apidoc_demo/目录下执行命令 >> apidoc -i myapp/ -o apidoc/
新建apidoc.json
{"name": "p1app_v2","description": "P1APP二期的接口文档","version": "0.0.1","title": "p1app_v2_doc","url": "https://localhost:8010/p1app_v2" }
新建一个demo.js
/*** @apiDefine Index 首页*//*** @api {post} /Index/getVip 获取vip列表 页面加载时自动获取* @apiName getVip* @apiGroup Index* @apiParam {string} req1 请求值* @apiSuccess (200) {Object[]} profiles List of user profiles. * @apiSuccess (200) {Number} profiles.age Users age. * @apiSuccess (200) {String} profiles.image Avatar-Image. * @apiSuccess (201) {String} failed Avatar-Image. * @apiSuccessExample {json} Success-Response:* {* res1:"test"* }*//*** @api {get} /Index/getWeather 获取指定日期的逐小时气象数据信息* @apiName getWeather* @apiGroup Index* @apiDescription 根据传递的行政区编码,获取所在城市的信息,得到城市对应的气象数据。* @apiParam {String} [date] 日期,格式yyyy-MM-dd,不传,默认为当日* @apiParam {String} region_code 行政区编码,如"500244"* @apiParam {String="hour","day","week","month","year"} data_type 数据类型* @apiParam {Number=10,20} num 记录最大返回条数* @apiParam {String{5...10}} strlen 字符串长度限制* @apiParam {Number{5-10}} num_range 数字范围* @apiParam {String{5-10}} str_range 字符串范围* @apiVersion 0.0.1* @apiSuccess {JsonObject} result JsonObject对象* @apiSuccessExample Success-Response: {"code": 0,"msg": "success","data":[{"date": "2019-05-30 01","humidity": 0.97}, {"date": "2019-05-30 02","humidity": 0.98}] }*/
效果图如下:
apidoc的注解说明:
@api {get} /users/:user_id Request User Information 最主要的参数,”{get}”定义了HTTP请求是GET,API地址是”/users/:user_id”,文档中API的名称是”Request User Information”。@apiVersion 0.1.0 API的版本号,默认显示在API名称的右方。该参数可用来在不同的版本之间做比较,后面会介绍。@apiName GetUser API名称,不影响文档。@apiGroup User API分组名,文档内容中和菜单栏中同一组的API会在一同显示,方便阅读。@apiPermission admin API的访问权限,文档中默认会API地址下面显示。没有权限要求的话,此项可以省略。@apiDescription API to get the user information. API的详细描述,默认显示在API名称的下方。@apiExample Example usage: API调用示例,该参数的下一行就是示例的内容,直到有空行结束。可以定义多个@apiExample,默认在文档中会以标签形式列出,标签名就是”Example usage:”。@apiParam {Number} user_id The user’s unique ID. API参数字段介绍,”{Number}”定义了字段类型,”user_id”是字段名称,后面则是字段描述。可以定义多个@apiParam字段。@apiSuccess {String} name Name of the User. API成功后返回的字段,如同@apiParam,”{String}”定义了字段类型,”name”是返回字段名称,后面则是字段描述。可以定义多个@apiSuccess字段。@apiSuccessExample {json} Success-Response: 显示一个API成功返回后Response响应的示例,”{json}”代表响应体是JSON类型。该参数的下行就是响应体内容,直到有空行结束。可以定义多个@apiSuccessExample,默认在文档中会以标签形式列出,标签名就是”Success-Response:”。@apiError UserNotFound User was not found. API发生错误后的返回,”UserNotFound”是错误名称,后面则是错误描述。可以定义多个错误返回。@apiErrorExample {json} Error-Response: 显示一个API错误返回后Response响应的示例,”{json}”代表响应体是JSON类型。该参数的下行就是响应体内容,直到有空行结束。可以定义多个@apiErrorExample,默认在文档中会以标签形式列出,标签名就是”Error-Response:”。@apiSampleRequest http://localhost:5000/users/:user_id 文档提供的API Sample测试的地址。其实在”apidoc.json”中配过”sampleUrl”项后,此参数即可省去,除非这个API的测试URL比较特殊,需特别指定。
使用js编写,这些注解都写在注释中,上面的内容引用自:https://www.jianshu.com/p/d324810d694d
参数定义说明:参考https://blog.csdn.net/qq_14824885/article/details/87793476#apiParam_251
apidoc使用中文说明:https://blog.csdn.net/qq_14824885/article/details/87793476
apidoc使用英文说明(官方文档):http://apidocjs.com/
针对版本变更以及对比,待继续学习.......
转载于:https://www.cnblogs.com/TheoryDance/p/10958145.html
apidoc学习(接口文档定义取代word)相关推荐
- apiDoc生成接口文档,不费吹灰之力
一个学习编程技术的公众号.每天推送高质量的优秀博文.开源项目.实用工具.面试技巧.编程学习资源等等.目标是做到个人技术与公众号一起成长.欢迎大家关注,一起进步,走向全栈大佬的修炼之路 效果 背景 之前 ...
- Api 接口文档是什么?如何直接使用 ApiDoc 生成接口文档
api接口文档 现代化开发大部分都是一种前后端分离的开发模式,前端与后端分别独立进行开发.等后续再去统一的联调.前后端分离的开发模式下,前后端沟通的成本增加,如何减少口头的交流成了关键.这时有一份高端 ...
- nodejs下的apidoc 帮助接口文档生成
在项目开发过程中,总会牵扯到接口文档的设计与编写,之前使用的都是office工具,写一个文档,总也是不够漂亮和直观.好在git上的开源大神提供了生成文档的工具,so来介绍一下! 该工具是Nodejs的 ...
- 基于 apidoc 生成在线接口文档 (实时更新)(linux系统)
基于 apidoc 生成在线接口文档 (实时更新)(linux系统) 动态加载,热部署 背景: 规范开发人员的接口文档 文档统一管理,防止本地文档版本不统一 远程部署,保证文档的统一性 主要还是解决, ...
- 【DEVOPS】实现Swagger2应用接口文档Word格式的在线实时更新
借助 maven plugin + 自定义服务Swagger2Word服务,实现满足自定义格式需求的RESTful API文档的实时更新和在线展示.(注意:这里的API接口文档是独立于应用的,不似Sw ...
- 如何编写一个好的规范中投证券L2接口文档?
如果你的案例可以直接依靠复制拿来使用,那这个文档就是好文档既然要简单,那就抓住核心:怎么简单怎么来,怎么省时间怎么来如果不知道怎么写,就把案例写的越详细越好.开发时间是非常宝贵的,而接口对接通常都是一 ...
- 用apidoc 生成在线接口文档
在开发接口的过程中,需要向外发布相应的接口文档.开始的时候使用word来写文档,时间长了发现有几个问题.1) 编写不方便.每次新增借口的时候都要复制上一个接口,然后再进行修改,一些相同的部分无法复用, ...
- python生成接口文档_使用apiDoc实现python接口文档编写
使用apiDoc实现python接口文档编写 apiDoc的安装 npm install apidoc -g 生成api的终端命令:apidoc -i 代码所在路径-o 生成文件的路径 接口文档的编写 ...
- apidoc 自动化生成 api接口文档
手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理 要用组件那就必须先安装 apidoc,做一下全局安装 npm install apidoc -g 新建配置文件apidoc. ...
最新文章
- 手机影音第六天 自定义播放器页面的实现(按钮暂时未监听)
- 图形处理相关资源(面部识别、姿态估计、变形、、、)
- 实战SSM_O2O商铺_48【用户登录】用户登录Dao-Service-Controller-View层的开发
- centos启动Nginx提示nginx: [emerg] still could not bind()
- 从概设流程、审美、设计思路几个方面,漫谈游戏美术设计的思维方式
- mysql8.0递归_mysql8.0版本递归查询
- BOS 系统 定区关联客户功能实现
- 《逻辑:你认为正确,就一定正确吗?》
- Hadoop实例学习(十三) Join应用
- CSMA/CD协议详解!!!
- Android 12 预览版发布,64g 手机用户哭了
- 鸿蒙系统第一批升级名单,鸿蒙系统首批升级名单详细介绍
- mysql学生表_课程表_选课表,连表查询
- 简单聊聊FPGA的一些参数
- ajax瀑布流加载重叠,使用瀑布流插件masonry,图片未加载完就会出现重叠现象,怎么解决?...
- spaceclaim简单建模3
- 直接import carla
- 2019最新《html5+css3课程 前端开发教程》
- intel酷睿游戏计算机,Intel酷睿九代i3-9100F配RX590游戏电脑配置单,预算3500元不到...
- 【C++】C++11新特性列表
热门文章
- 【转载】关于阿里巴巴的问题
- 35.页面置换算法有哪些?
- error C2660: 'MessageBoxA' : function does not take 4 parameters
- getchar()到底怎么用_脱霉剂到底该怎么用?
- 1920+1080+android三星手机,三星Galaxy Note3能拍摄1080p视频吗?支持1080p播放吗?
- html 按下和松开事件,JQuery通过键盘控制键盘按下与松开触发事件
- Tomcat的Classpath-常见问题以及如何解决
- Oracle NVL()和NVL2()函数
- 105_键盘事件对象
- 013_logback中的SyslogAppender