@SuccessResponse
指定接口成功返回的示例数据,用法:@SuccessResponse 返回类型 返回状态码 其他说明。
返回类型 为常见的http返回类型,如:text/html、text/xml、image/png、application/json等。
返回状态码 为常见的http返回状态码,如:200、301等。
该指令可以定义多条,用来区分不同的返回情况。
示例:
/**
* @ApiStart
*
* @Name getDemo
* @Group demoGroup
*
* @Api get /api/getTest
*
* @QueryParam {Number} page 此处page为必传字段
*
* @SuccessResponse application/json 200 success response demo
*
* {
* status: "success",
* data: {}
* }
* @SuccessResponse application/json 201 success created info
*
* {
* status: "success",
* data: {}
* }
*
* @ApiEnd
*/
如上注解会生成一下内容:
