基于tp5的在线文档

浏览:1814 最后更新:2018-06-03 23:24 分类:类库 关键字: api在线文档
1.安装
// 使用composer安装
composer require hao/api-doc
####2、配置参数 安装好扩展后在 application\extra\ 文件夹下会生成 doc.php 配置文件 在controller参数中添加对应的类

'controller' => [
'app\\api\\controller\\Demo'
]
####3、在相关接口类中增加注释参数( group 参数将接口分组,可选) 方法如下:返回参数支持数组及多维数组(参考test文件夹中的Index.php文件)

接口备注示例
返回数据格式,仅支持json数据格式

<?php
namespace app\reflection\controller;


/**
* @title 文档index类
*/
class Index{
public function __construct(){

}

/**
* @title save方法
* @description
* @author 作者
* @url http://www.baidu.com/save.html
* @method POST
*
* @code 200 成功
* @code 201 失败
*
* @param string name 名称 '' false
* @param int age 年龄 '' false
* @return {"code":200,"message":"666","data":{"param":1}}
*/
public function save(){

}

/**
* @title delete方法
* @description ajax请求时,header带上Authorization信息;Authorization即为user_id token值(两个参数之间,用英文空格)
* @author 作者
* @url http://www.baidu.com/delete.html
* @method POST
*
* @code 200 成功
* @code 201 失败
*
* @param string name2 名称2 null false
* @param int age2 年龄2 null false
* @return {"code":400,"message":"111","data":[{"param":1}]}
*/
public function delete(){

}
}
####4、在浏览器访问http://你的域名/doc 查看接口文档

评论( 相关
后面还有条评论,点击查看>>