API开发文档构建

214 阅读1分钟


1.下载Node.js

nodejs.cn/download/

(注:高版本的JS自带了NPM,所以我们不用另外去安装NPM)

在cmd中查看是否安装成功:

node -v

npm -v


2. 安装apidoc

cnpm install apidoc -g


在CMD中查看是否安装成功:

apidoc -v


3.构建文档目录:

我已经搭建好了目录架构,zip包如下:

链接: https://pan.baidu.com/s/1l_xiBNp0qdtgwGKXUPs1-A

重点在于编写apidoc.json和myapp.java两个文件


4.使用方法

在E:\workspace\apidoc\apidoc\in下:

编辑myapp.java文件即可


在cmd中键入以下命令(注意修改path)

apidoc -i E:\workspace\apidoc\in -o E:\workspace\apidoc\out

最后打开E:\workspace\apidoc\out下的index.html即可

附:具体在项目中,由开发者将自己开发好的api更新,然后提交到公共盘或者SVN上,保证每次都是最新的文档,前端开发人员开发时只需在公共盘或者SVN上查看即可,省时省力,便于管理。


参考链接:

http://www.bjhee.com/apidoc.html

https://segmentfault.com/q/1010000005801746