[toc]

使用文档注解

注解在类上

使用@Doc注解

当@Doc("api权限管理")时，分组名为"api权限管理",描述为空

当@Doc(value = "api权限管理", remark = "这里是描述")

当没有@Doc注解时，分组名为类名

@RestController
@RequestMapping(value="/api_permission")
@Doc("api权限管理")
public interface ApiPermissionService extends GenericBaseService<ApiPermission>{
    ...
}

注解在方法上

同样使用@Doc 注解对参数进行说明

@Doc相关属性说明

使用@IgnoreParameter来排除某些不需要的参数

@IgnoreParameter相关属性说明

以下三种写法等同

@IgnoreParameter(ignore = {"orderBy", "sord"})
@IgnoreParameter(value = "orderBy,sord")
@IgnoreParameter("orderBy,sord")

使用@RequireParameter来设置某些参数为必须传递的

@RequireParameter相关属性说明

以下三种写法等同

@RequireParameter(require = {"page", "rows"})
@RequireParameter(value = "page,rows")
@RequireParameter("page,rows")

使用@ParameterFilter来设置必传参数，忽略参数，仅包含的参数

@ParameterFilter 集成了@IgnoreParameter 和 @RequireParameter 的功能，另还包括了仅包含指定参数的功能

@ParameterFilter相关属性说明

使用@ReturnDoc来描述响应的数据

@ReturnDoc 通常作用于返回基本类型的方法，比如方法返回String Long int boolean等类型时

@ReturnDoc相关属性说明

使用@ReturnFilter来过滤响应数据

@ReturnFilter相关属性说明

注解在JAVABEAN属性上

同样使用@Doc 注解对属性进行说明

@Doc相关属性说明