使用APIDOC自动生成api接口文档

安装nodejs和npm

Centos参考这个链接安装nodejs和npm

apidoc依赖node.js的npm管理工具,安装方法如下

sudo apt-get install nodejs
curl http://npmjs.org/install.sh | sudo sh

安装apidoc

sudo npm install apidoc -g

使用

<?php
class test{

/**
 * @api {get} /aaa/user 获取用户
 * @apiHeader {String} access-key Users unique access-key.
 * @apiName GetUser
 * @apiGroup User
 * 
 * @apiParam {Number} id 用户id

 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 * @apiSuccessExample {json} Success-Response:
 *     HTTP/1.1 200 OK
 *     {
 *       "firstname": "John",
 *       "lastname": "Doe"
 *     }
 */
function user(){

}

}

apidoc.json

{
  "name": "api",
  "version": "0.1.0",
  "description": "这里是描述",
  "title": "这里是title",
  "url" : "这里是url"
}

 

生成命令

apidoc -i ./  -o apidoc/

生成的文档如下所示

QQ截图20151020143809

参考链接

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注