SwaggerUI开发的简单使用

DBC 1.6K 0
这个给一个例子
@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);
    }
简单讲解

这里最需要懂的就是这两个@ApiImplicitParams、@ApiResponses

@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的值是一样的,那么其实效果都是一样的,这里写两个让你更好的理解这里其实是一个列表的意思!

温馨提示

这个位置就是这个接口结果的显示,你可以传入一个实体类,如果返回的结果是很多实体类组成,那么操作应该是构件一个SwaggerUI专门使用的大实体类,里面可以放入你返回的全部实体类和参数!
比如例子里面的就是JsonDate+BigActivityVO类,他只会显示一个!

发表评论 取消回复
表情 图片 链接 代码

分享