测试文件更新

This commit is contained in:
IT小强xqitw.cn 2018-06-07 13:56:02 +08:00
parent ae700da7bb
commit e8d54fdabb
3 changed files with 31 additions and 36 deletions

View File

@ -11,28 +11,39 @@
*/
/**
* @title 测试用的API类
* @title 登录注册
* Class Api
*/
class Api
{
/**
* @title 添加操作
* @url https://wwww.baidu.com
* @title 用户登录API
* @url https://wwww.baidu.com/login
* @method POST
* @param array|string|bool id 用户ID null 必须
* @param array|string|bool id2 用户ID2 false 必须
* @param string username 账号 必须
* @param string password 密码 必须
* @code 1 成功
* @code 2 失败
* @return int code 状态码(具体参见状态码说明)
* @return string msg 提示信息
* @return object data 返回的数据
*/
public function add() {
public function login() {
return json_encode(['code' => 1, 'msg' => '登录成功']);
}
public function edit() {
/**
* @title 用户注册API
* @url https://wwww.baidu.com/reg
* @method POST
* @param string username 账号 必须
* @param string password 密码 必须
* @param string password2 重复密码 必须
* @code 1 成功
* @code 2 失败
* @return int code 状态码(具体参见状态码说明)
* @return string msg 提示信息
*/
public function reg() {
return json_encode(['code' => 1, 'msg' => '注册成功']);
}
}

View File

@ -9,41 +9,25 @@
* copyright (c) 2016 - 2018 mail@xqitw.cn
* ==================================================================
*/
/**
* @title 测试用的API类2
* @title 用户相关
* Class Api
*/
class Api2
{
/**
* @title 添加操作
* @url https://wwww.baidu.com
* @method POST
* @param array|string|bool id 用户ID null 必须
* @param array|string|bool id2 用户ID2 false 必须
* @title 获取用户信息
* @url https://wwww.baidu.com/getuserinfo
* @method GET
* @param int uid 用户ID 0 必须
* @param string token 令牌 必须
* @code 1 成功
* @code 2 失败
* @return int code 状态码(具体参见状态码说明)
* @return string msg 提示信息
* @return object data 返回的数据
*/
public function addxx() {
}
/**
* @title 添加操作
* @url https://wwww.baidu.com
* @method POST
* @param array|string|bool id 用户ID null 必须
* @param array|string|bool id2 用户ID2 false 非必须
* @code 1 成功
* @code 2 失败
* @return int code 状态码(具体参见状态码说明)
* @return string msg 提示信息
* @return object data 返回的数据
*/
public function editcccc() {
public function getUserInfo() {
return json_encode(['code' => 1, 'msg' => '获取信息成功', 'data' => ['uid' => 1, 'username' => 'admin']]);
}
}

View File

@ -13,7 +13,7 @@ require_once __DIR__ . '/../vendor/autoload.php';
require_once __DIR__ . '/Api.php'; // 加载测试API类1
require_once __DIR__ . '/Api2.php'; // 加载测试API类2
$config = [
'class' => ['Api2', 'Api2', 'Api2', 'Api'], // 要生成文档的类
'class' => ['Api', 'Api2'], // 要生成文档的类
'filter_method' => ['__construct'], // 要过滤的方法名称
];
$api = new \itxq\apidoc\BootstrapApiDoc($config);