跳到主要内容

@Define&@Reuse

@Define 用来定义复用的公共模块,通常用来复用一些相同的设置,如请求头部,请求参数等。 复用模块可以通过@Reuse引用。

用法:@Define moduleName@Reuse moduleName

示例:

// 定义复用模块ReuseItem
/**
* @ApiStart
*
* @Define ReuseItem
*
* @HeaderParam {String} access-token the request token in header
*
* @QueryParam {Integer} page current page
* @QueryParam {Integer} pageSize current page size
*
* @ApiEnd
*/

注:在@Define定义的模块中,@Api@Name@Define@Reuse等注解命令会失效。其他指令均可正常使用。

// 引用该模块
/**
* @ApiStart
*
* @Name getDemo
* @Group demoGroup
*
* @Api get /api/getTest
*
* @QueryParam {String} id 查询参数id
*
* @Reuse ReuseItem
*
* @ApiEnd
*/

上述接口引用定义的公共模块后,该接口会自动引入@HeaderParam; 同时,由于接口自身有定义@QueryParam {String} id,引入的公共模块ReuseItem 中的所有@QueryParam将不会起作用。