API注解

通过注解控制器请求类型、参数、生成调试表单等

/**
 * 默认方法
 *
 * @cp_api post, /hello, hello
 * @cp_request t|时间|1
 * @throws
 */
function index()
{
    $this->display($this->data);
}

限制请求类型

通过添加 @cp_api 注解控制API接收的请求方法

@cp_api post, /hello, hello
  • 接受POST请求，可以指定post, get, any中的一个
  • 接口相对服务器Host地址为/hello
  • 接口名称为hello(接口名称标识)

限制请求参数

注解@cp_request 限制接口参数， 参数|参数名|1, 多个参数用逗号分割

@cp_request t|时间|1

  • 参数名，可以用参数名:表单类型控制表单形式

    • file 生成一个文件上传表单
    • multi_file 多文件上传表单
    • select 生成下拉表单，如 s:select|1-a 2-b|1
    • textarea 生成一个textarea输入框

  • 参数说明

  • 是否必传 0-可选 1-必传

接口文档分类名称

@cp_api_spec 名称 控制分类名称

类注释中生效

忽略类

@cp_api_ignore 忽略该类

忽略公共参数

@cp_global_params 忽略公共参数, 可同时应用于类和方法

目录