apiDoc 入门
网站
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,里面就是生成的接口页面
apiDoc 入门的更多相关文章
- [置顶] 轻量级语言Lua入门
作为一个脚本爱好者,而且是脚本(Perl)起家的我,一有空就喜欢学习下这些脚本语言.据说魔兽世界.愤怒小鸟都用到了它,所以今天研究下Lua这个叫法有点奇特的脚本 [转载请注明出处:http://blo ...
- Dropwizard入门及开发步骤
Dropwizard介绍 Dropwizard结构的服务组成 开发步骤 Dropwizard介绍 Dropwizard是一个微服务框架, 是各项技术的一个集成封装.它包含了以下组件: 嵌入式Jetty ...
- MyBatis 学习总结 01 快速入门
本文测试源码下载地址: http://onl5wa4sd.bkt.clouddn.com/MyBatis0918.rar 一.Mybatis介绍 MyBatis是一个支持普通SQL查询,存储过程和高级 ...
- Python3入门(一)——概述与环境安装
一.概述 1.python是什么 Python 是一个高层次的结合了解释性.编译性.互动性和面向对象的脚本语言. Python 是一种解释型语言: 这意味着开发过程中没有了编译这个环节.类似于PHP和 ...
- OpenLayers 3 入门教程
OpenLayers 3 入门教程摘要OpenLayers 3对OpenLayers网络地图库进行了根本的重新设计.版本2虽然被广泛使用,但从JavaScript开发的早期发展阶段开始,已日益现实出它 ...
- Nginx 极简教程(快速入门)
作者:dunwu github.com/dunwu/nginx-tutorial 推荐阅读(点击即可跳转阅读) 1. SpringBoot内容聚合 2. 面试题内容聚合 3. 设计模式内容聚合 4. ...
- Mysql快速入门(看完这篇能够满足80%的日常开发)
这是一篇mysql的学习笔记,整理结合了网上搜索的教程以及自己看的视频教程,看完这篇能够满足80%的日常开发了. 菜鸟教程:https://www.runoob.com/mysql/mysql-tut ...
- Node js 入门指南(1)
目录 Node Js 定义 特点 Node使用方式 Tip: 使用导出文件的注意事项 Node 内置模块 http 模块 定义 使用方法 fs 模块 定义 使用方法 读取文件方式 同步读取 异步读取 ...
- ShowDoc,APIDoc,可道云API,语雀-适合IT企业的文档工具
ShowDoc,APIDoc,可道云API,语雀-适合IT企业的文档工具 一.ShowDoc官方文档及说明 1.1 它可以用来做什么 1.2 它都有些什么功能 1.3 使用在线的ShowDoc 1.4 ...
随机推荐
- Jetson tx2 串口通信
主要参考了这篇博客:https://blog.csdn.net/zomb1e0117/article/details/85157014 其中需要注意的是最后的时候cutecom端口需要把设备改为:/d ...
- Log4net 配置实例
首先需要下载并引用Log4net的binary.这一步可以通过在Visual Studio里的Manage Nuget package for solution轻松添加. 第二步是配置config文件 ...
- 成都Uber优步司机奖励政策(1月21日)
滴快车单单2.5倍,注册地址:http://www.udache.com/ 如何注册Uber司机(全国版最新最详细注册流程)/月入2万/不用抢单:http://www.cnblogs.com/mfry ...
- Openstack Havana的两个排错过程
问题一:Timeout wating on RPC response, topic:"network" 描述: 启动实例一直等待,然后变为error.查看日志,是 timeout ...
- Homebrew安装Redis找不到redis.conf文件
使用Homebrew安装redis完成后,使用命令 redis-server 启动redis,如下图所示: 启动信息中存在一条警告信息:没有指定的配置文件 然而在安装目录中并没有发现redis.con ...
- 【费元星原创】一键安装Hadoo2.7.6 集群完全分布式脚本-完美解决
有Bug 欢迎反馈,我不烦:feiyuanxing@gmail.com 1 #!/bin/bash #@author:feiyuanxing [既然笨到家,就要努力到家] #@date:2017-01 ...
- Ubuntu 14.04 登录 界面添加 root账号
1打开终端输入:sudo gedit /usr/share/lightdm/lightdm.conf.d/50-ubuntu.conf 2在弹出的编辑框里加入:greeter-show-manual- ...
- leetcode-最长上升子序列LIS
转载原文地址:http://www.cnblogs.com/GodA/p/5180560.html 给定一个无序的整数数组,找到其中最长上升子序列的长度. 示例: 输入: [10,9,2,5,3,7, ...
- lintcode39 恢复旋转排序数组
恢复旋转排序数组 给定一个旋转排序数组,在原地恢复其排序. 您在真实的面试中是否遇到过这个题? Yes 说明 什么是旋转数组? 比如,原始数组为[1,2,3,4], 则其旋转数组可以是[1,2,3 ...
- 浅谈java中接口与抽象类之间的异同
刚学习java的时候,总觉得接口和抽象类很像,但又说不上具体有什么区别.今天静下来,翻翻书,查查资料,做个小结.首先举两个例子,看看interface和abstract class 在“外形”上有啥异 ...