@Model
@Model 自定义类型,可当做自定义类型使用,即所有可以指定类型的地方,都可以引用自定义类型。
其内部只可包含@Property属性指令。
用法:@Model moduleName description info 用来定义,然后通过&moduleName引用。
示例:
// 自定义类型personModel
/**
* @ApiStart
*
* @Model PersonModel 自定义personModel
*
* @Property {String} name 姓名
* @Property {Integer} age 年龄
* @Property {String} sex 性别
*
* @ApiEnd
*/
引用该自定义类型
// 引用该模块
/**
* @ApiStart
*
* @Api post /api/add/test
* @Name postDemo
* @Group demoGroup
*
*
* @BodyParam {&PersonModel} personInfo 用户的基本信息
* @BodyParam {Boolean} isStudent 是否为学生
*
* @SuccessResponse application/json 200 正常请求返回参数
* {
* result: "success",
* data: {}
* }
*
* @ErrorResponse application/json 400
* {
* result: "fail",
* message: "some error message"
* }
*
* @ApiEnd
*/
如上注解会生成以下内容:

在@SuccessResponse和@ErrorResponse中使用自定义类型:
/**
* @ApiStart
*
* @Model SuccessModel 自定义成功返回
*
* @Property {String} status 请求状态
* @Property {Array} data 返回的数据
* @Property {Integer} total 总条目数
* @ApiEnd
*/
/**
* @ApiStart
*
* @Model ErrorModel 自定义失败返回
*
* @Property {String} status 请求状态
* @Property {String} msg 失效的相关描述内容
* @ApiEnd
*/
/**
* @ApiStart
*
* @Api post /api/add/response
* @Name responseDemo
* @Group demoGroup
*
*
* @BodyParam {&PersonModel} personInfo 用户的基本信息
* @BodyParam {Boolean} isStudent 是否为学生
*
* @SuccessResponse application/json 200 {&SuccessModel}
*
* @ErrorResponse application/json 400 {&ErrorModel}
*
* @ApiEnd
*/
如上注解会生成以下内容:

自定义类型的属性替换
引用自定义类型时,可以通过&moduleName(key:&moduleName2)进行相关属性的替换
/**
* @ApiStart
*
* @Api post /api/add/response
* @Name responseDemo2
* @Group demoGroup
*
*
* @BodyParam {&PersonModel[]} personInfo 用户的基本信息
* @BodyParam {Boolean} isStudent 是否为学生
*
* @SuccessResponse application/json 200 {&SuccessModel(data:&PersonModel)}
*
* @ErrorResponse application/json 400 {&ErrorModel}
*
* @ApiEnd
*/
如上注解会生成以下内容:
