QQ扫一扫联系
使用注解可以在模块打包时生成接口文档，一个接口文档注解示例如下
/**
* @Api 新闻
*/
class NewsController extends Controller
{
/**
* @Api 新闻分页
* @ApiBodyParam search.categoryId int 新闻分类ID
* @ApiResponseData {
* "total": 1,
* "page" : 1,
* "pageSize": 10,
* "records": [
* {
* "id":1,
* "categoryId":1,
* "title":"标题",
* "summary":"摘要",
* "content":"内容"
* }
* ]
* }
*/
public function paginate()
{
// ...
}
}
@Api 分组
@Api 名称
@ApiDesc 接口说明
@ApiMethod post|get
@ApiDataType json|formData
@ApiHeadParam api-token string required 参数说明
@ApiBodyParam bizId int required 企业ID
@ApiQueryParam bizId int required 企业ID
@ApiResponseCode 10000 用户未登录
@ApiResponseData { }
