这个给一个例子
@GetMapping("getActivityMonthLists") @Log("查询指定日期活动列表") @ApiOperation("查询指定日期活动列表(精确到月) 活动查看 ——DBC") @PreAuthorize("@el.check('admin','activitiesList:list')") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "date", value = "传入查询的日期——月 例:2021-05", required = true, dataType = "String"), @ApiImplicitParam(paramType = "query", name = "userId", value = "传入用户id", required = true, dataType = "String"), }) @ApiResponses({ //响应信息 @ApiResponse(code = 0, message = "操作成功状态信息",response = BigActivityVO.class), @ApiResponse(code = 0, message = "操作成功状态信息",response = JsonData.class) }) public JsonData getActivityMonthLists(String date, String userId) { ArrayList<BigActivityVO> lists = activitiesListService.getActivityMonthLists(date, userId); return JsonData.buildSuccess(lists); }
@ApiImplicitParam
@ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "date", value = "传入查询的日期——月 例:2021-05", required = true, dataType = "String"), @ApiImplicitParam(paramType = "query", name = "userId", value = "传入用户id", required = true, dataType = "String"), })
上面可以看得很清楚,这里就是对参数的额说明,让接口说明好看一些
@ApiResponses
@ApiResponses({ //响应信息 @ApiResponse(code = 0, message = "操作成功状态信息",response = BigActivityVO.class), @ApiResponse(code = 0, message = "操作成功状态信息",response = JsonData.class) })
这里好像code的值是一样的,那么其实效果都是一样的,这里写两个让你更好的理解这里其实是一个列表的意思!
本文作者为DBC,转载请注明。