代码文件\app\controller\api\Demo.php有接口注解规范的举例。
注解包括，控制器头部注解，控制器方法注解两个部分
| 名称 | 描述 | 示例 |
|---|---|---|
| @ApiSector | API分组名称 | (测试分组) |
| @ApiRoute | API接口URL，此@ApiRoute只是基础URL | (/api/test) |
| @ApiInternal | 忽略的控制器,表示此控制将不加入API文档 | () |
| @ApiWeigh | API方法的排序,值越大越靠前。注意：这个值不能重复 | (99) |
| 名称 | 描述 | 示例 |
|---|---|---|
| @ApiTitle | API接口的标题,为空时将自动匹配注释的文本信息 | (测试标题) |
| @ApiSummary | API接口描述 | (测试描述) |
| @ApiRoute | API接口地址,为空时将自动计算请求地址 | (/api/test/index) |
| @ApiMethod | API接口请求方法,默认为GET | (POST) |
| @ApiSector | API分组,默认按钮控制器或控制器的@ApiSector进行分组 | (测试分组) |
| @ApiParams | API请求参数,如果在@ApiRoute中有对应的{@参数名}，将进行替换 | (name=”id”, type=”integer”, required=true, description=”会员ID”) |
| @ApiHeaders | API请求传递的Headers信息 | (name=token, type=string, required=true, description=”请求的Token”) |
| @ApiReturn | API返回的结果示例 | ({“code”:1,”msg”:”返回成功”}) |
| @ApiReturnParams | API返回的结果参数介绍 | (name=”code”, type=”integer”, required=true, sample=”0”) |
| @ApiReturnHeaders | API返回的Headers信息 | (name=”token”, type=”integer”, required=true, sample=”123456”) |
| @ApiInternal | 忽略的方法,表示此方法将不加入文档 | () |
| @ApiWeigh | API方法的排序,值越大越靠前。注意：这个值不能重复 | (99) |