//@desn:apidoc linux环境  windows环境使用

//@desn:码字不宜,转载请注明出处

//@author:张慧源  <turing_zhy@163.com>

//@date:2018/5/6

正文:

windows版安装:

1.安装nodejs   (nodejs环境)

32 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x86.msi

64 位安装包下载地址 : https://nodejs.org/dist/v4.4.3/node-v4.4.3-x64.msi

2.安装apidoc,

npm install -g apidoc

使用第一个命令版  运行上面的命令安装

linux版安装(ubuntu)

1、更新ubuntu软件源

sudo apt-get update 
sudo apt-get install -y python-software-properties software-properties-common 
sudo add-apt-repository ppa:chris-lea/node.js 
sudo apt-get update

2、安装nodejs

sudo apt-get install nodejs 
sudo apt install nodejs-legacy 
sudo apt install npm

3、更新npm包镜像源

sudo npm config set registry https://registry.npm.taobao.org 
sudo npm config list

4、全局安装n管理器(用于管理nodejs版本)

sudo npm install n -g

5、安装最新的nodejs(stable版本)

sudo n stable 
sudo node -v   (查看版本)

6、安装apidoc

sudo npm install apidoc -g

使用:以TP框架为例

在网站根目录放上模板  .json

内容:

{
"name": "example",
"version": "0.1.0",
"description": "A basic apiDoc example"
}

这里上个我代码里的注释(apidoc就是把注释转换为接口文档)

  1. /**
    * @api {POST} http://aaa.com/index/Index/add_needs 添加用户需求
    * @apiVersion 1.0.0
    * @apiGroup NEED
    *
    * @apiParam {String} need_name 需求者名称-非空
    * @apiParam {String} e_mail 用户邮箱-非空邮箱格式
    * @apiParam {String} phone 用户电话-非空
    * @apiParam {String} company_name 需求公司名称-非空
    * @apiParam {String} needs_desc 需求描述-非空
    *
    * @apiSuccess {Object} code 返回码
    * @apiSuccess {Object} reason 中文解释
    * @apiSuccess {String[]} data 返回数据
    *
    * @apiSuccessExample {json} Success-Response:
    * HTTP/1.1 200 OK
    * {
    * "code":0,
    * "reason":"需求已经提交了,我们的工作人员会在2个工作日内和您取得联系!",
    * "data":[]
    * }
    */
  2.  
  3. 注释参考:http://apidocjs.com (apidoc官网)
  4.  
  5. TP为参考的重点:生成的docapi放在public
    命令:apidoc -i ./ -o ./public/apidoc 注:-i 应用目录 -o 输出apidoc位置 另命令要cd到应用根目录下运行
  6.  
  7. 效果展示:

  1.  

接口文档神器之apidoc的更多相关文章

  1. 快速根据注释生成接口文档网页工具——Apidoc的使用教程

    1,安装Node.js的npm工具环境: 如有不懂,请看我的博客:“https://blog.csdn.net/sinat_28371057/article/details/81612661“ 2,n ...

  2. web接口文档apidoc的使用

    1.安装 npm install apidoc -g 2.新建src文件夹,里面放2个文件,test.js和apidoc.json 3.test.js /** * @api {get} /query_ ...

  3. 在sublime3中docblockr插件配置apidoc接口文档注释模板

    写在前面: 将进行3个步骤配置 1.在sublime3中安装插件docblockr,可以参考http://www.cnblogs.com/jiangxiaobo/p/8327709.html 2.安装 ...

  4. apidoc接口文档的快速生成

    官方文档连接:http://apidocjs.com/#demo apidoc是一个轻量级的在线REST接口文档生成系统,支持多种主流语言,包括Java.C.C#.PHP和Javascript等.使用 ...

  5. apidoc 接口文档系统

    代码未动,文档先行.apidoc可以方便地维护接口文档.模拟响应数据.前后端分离.导出PDF文档. 特性说明 可视化编辑:支持表单界面编辑接口,不必手动编辑swagger.json 接口模拟响应:支持 ...

  6. apidoc学习(接口文档定义取代word)

    apidoc的安装,参考:https://blog.csdn.net/qq_36386771/article/details/82149848 生产文档,需要先编写一个apidoc.json对接口文档 ...

  7. Swagger+Spring mvc生成Restful接口文档

    简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集 ...

  8. webApi文档好帮手-apidoc使用教程

    来源:http://blog.csdn.net/xumin198908/article/details/41964159 在开发后台接口的过程中,我们肯定要提供一份api接口文档给终端app. 目前大 ...

  9. RESTful API接口文档规范小坑

    希望给你3-5分钟的碎片化学习,可能是坐地铁.等公交,积少成多,水滴石穿,谢谢关注. 前后端分离的开发模式,假如使用的是基于RESTful API的七层通讯协议,在联调的时候,如何避免配合过程中出现问 ...

随机推荐

  1. 学习笔记-JS公开课一

    JS公开课笔记 没特别说明就是和Java语言一样. JS变量:弱类型语言 1.在JS中,true表示1,false表示0.和Java不一样. 2. var y: 提示undefined: 3.如果al ...

  2. 【linux学习笔记】Sublime Text3支持GB2312和GBK编码以及中文输入法

    几天在ubuntu15.10下使用Sublime Text3发现中文乱码,以及不能使用中文输入法(搜狗输入法linux版)的问题,捣鼓了半天,终于完善了,下面po一下我的解决方案. 一.支持GB231 ...

  3. Java多种方式读文件,追加文件内容,等对文件的各种操作

    一.多种方式读文件内容. 1.按字节读取文件内容 2.按字符读取文件内容 3.按行读取文件内容 4.随机读取文件内容 import java.io.BufferedReader; import jav ...

  4. foreach 内嵌的使用

    foreach内部处理数据流的每条记录,进行关系操作,最后用generate返回数据给外部.但注意关系操作符不能作用于表达式,要将表达式提取成关系. foreach内部只支持distinct, fil ...

  5. Coco2dx制作一个3D旋转的效果

    建了工程之后修改HelloWorldScene.cpp文件,修改部分为 // on "init" you need to initialize your instance bool ...

  6. Microsoft Office Excel cannot access the file, There are several possible reasons

    今天在做EXCEL打印读取模板时报错了,错误信息如下: Microsoft Excel cannot access the file 'D:\xx.xlsx'. There are several p ...

  7. 【一天一道LeetCode】#48. Rotate Image

    一天一道LeetCode系列 (一)题目 You are given an n x n 2D matrix representing an image. Rotate the image by 90 ...

  8. JVM学习笔记 -- 从一段几乎所有人代码都会犯错的代码开始

    废话不多说 看看这段代码.告诉我结果: import java.io.*; class Test { public static Test t = new Test(); public Test(){ ...

  9. Dynamics CRM2011 隐藏sub-grid 新建项和添加现有项按钮

    在CRM2011中ribbon区的自定义按钮可以通过工具例如RibbonEditor或者RibbonWorkbench进行配置包括action.display等等,但是系统级别的按钮是不能进行编辑的, ...

  10. Android Studio JNI javah遇到的问题

    好久没写博客了.持之以恒的勋章也被收回了.以后要好好坚持.. 最近在学习jni,但是遇到了一点麻烦的问题.好在终于解决了,便记下来解决一下. 其他入门的jni文章有很多,这里便不在累赘,直接上我遇到的 ...