基于php开发的RESTful ApiDoc文档
2017-04-10 10:47
381 查看
apiDoc基于rest的web API文档生成器,可以根据代码注释生成
使用apiDoc不需要自己麻烦的调word的格式,就可以生成一份漂亮的API文档。既美观又可以装逼。。。先看效果
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208171117366-506922428.png)
1、安装:
php运行环境:php(5.5.12) + apiDoc 。apiDoc的安装我们可以通过 npm 命令来安装。apiDoc基于NodeJS实现,所以你需先有NodeJS及NPM环境 windows安装node如下,直接下一步即可:
node官网:https://nodejs.org (最新下载地址:
https://nodejs.org/dist/v6.9.2/node-v6.9.2-x64.msi )
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163016210-327789917.png)
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163143601-932251473.png)
通过在命令行模式下,node -v即可查看当前node的版本、npm -v 即可查看当前 node 集成的 npm 的版本。
2、新建一个apiDoc的目录,并进入当前目录。运行 npm install apidoc 即可完成 apidoc模块的安装。
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163927679-12393469.png)
此时所有准备工作已经完成,就可以进入编写apidoc文档的工作了。
3、通过编写apidoc.json 和 test.php文件,然后在命令行下,执行命令 apidoc test.php 即可生成一个doc目录。
注意:通过此命令 apidoc test.php 生成的文档会包含默认的模板内容,修改 api_data.json、api_data.js文件,删除多余内容即可。
更多内容请参考官方文档:
官网主页: http://apidocjs.com
github: https://github.com/apidoc/apidoc
demo下载地址:链接:http://pan.baidu.com/s/1bpCCr5X 密码:d14d
web api文档,自动生成静态的html网页文档,不仅支持项目版本号,还支持API版本号。
使用apiDoc不需要自己麻烦的调word的格式,就可以生成一份漂亮的API文档。既美观又可以装逼。。。先看效果
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208171117366-506922428.png)
1、安装:
php运行环境:php(5.5.12) + apiDoc 。apiDoc的安装我们可以通过 npm 命令来安装。apiDoc基于NodeJS实现,所以你需先有NodeJS及NPM环境 windows安装node如下,直接下一步即可:
node官网:https://nodejs.org (最新下载地址:
https://nodejs.org/dist/v6.9.2/node-v6.9.2-x64.msi )
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163016210-327789917.png)
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163143601-932251473.png)
通过在命令行模式下,node -v即可查看当前node的版本、npm -v 即可查看当前 node 集成的 npm 的版本。
2、新建一个apiDoc的目录,并进入当前目录。运行 npm install apidoc 即可完成 apidoc模块的安装。
![](http://images2015.cnblogs.com/blog/553900/201612/553900-20161208163927679-12393469.png)
此时所有准备工作已经完成,就可以进入编写apidoc文档的工作了。
3、通过编写apidoc.json 和 test.php文件,然后在命令行下,执行命令 apidoc test.php 即可生成一个doc目录。
注意:通过此命令 apidoc test.php 生成的文档会包含默认的模板内容,修改 api_data.json、api_data.js文件,删除多余内容即可。
更多内容请参考官方文档:
官网主页: http://apidocjs.com
github: https://github.com/apidoc/apidoc
demo下载地址:链接:http://pan.baidu.com/s/1bpCCr5X 密码:d14d
相关文章推荐
- 基于php开发的RESTful ApiDoc文档
- 搭建 Windows 下基于 Eclipse 的 PHP 开发环境
- 搭建Windows下基于Eclipse 的 PHP 开发环境
- 基于Joomla系统的Ucenter 应用开发与用户整合开发文档
- 建立基于需求的文档软件开发体制
- PHP(1):基于Windows环境下的PHP开发环境搭建
- 搭建Windows下基于Eclipse的PHP开发环境
- 搭建Windows下基于Eclipse 的 PHP 开发环境
- 基于Oracle数据库OCI的开发文档
- 基于ZendFramework提炼PHP开发规范
- 基于Visual C++2010与windows SDK fo windows7开发windows7平台的tabletpc应用(2)-轨迹多文档手写轨迹输入多语言识别范例
- 基于PHP开发WEB程序之工具推荐
- [转] 搭建Windows下基于Eclipse的PHP开发环境
- 搭建Windows下基于Eclipse 的 PHP 开发环境
- 自己开发基于Web的在线编辑文档控件,可以在线编辑任意文档
- 基于Oracle数据库OCI的开发文档
- 基于PHP与XML的PDF文档生成技术
- 基于git的Gentoo中文文档开发流程[zt]
- 关于基于sharepoint开发文档管理系统的功能规划
- 在 Windows 下安装 PHP 开发环境(基于 Appserv)