Swagger接口文档

Posted 2023-03-23

参考技术A @ApiOperation(value = "分页查询用户", notes = "" +
"部分机密的查询字段、返回字段需要另外申请授权；\n" +
"【关键字段】提示（详见字段备注）：\n" +
"1、判断用户是否失效，status;\n" +
"2、获取用户所在组织，directDepartId;如果需要获取用户所在部门或系统，自行实现：根据部门全路径以及每个部门的级别判断\n" +
"【信息安全】提示：\n" +
"1、用户邮箱、手机、教育、职级等个人敏感消息请勿泄露给普通用户\n" +
"此接口可提供的【功能示例】：\n" +
"1、【根据多个工号查询用户】，必要参数usernames;\n" +
"2、【根据部门查询用户】，必要参数departmentId（部门ID），不包含子组织\n" +
"其他1、【全量同步用户】，只用于初始化用户数据，先查出所有部门，再按部门查询用户\n" +
"其他2、【增量同步用户】，对接消息推送服务，对接文档："
)
@ApiImplicitParams(value =
@ApiImplicitParam(name = "pageIndex", value = "页码,默认1", paramType = "query", defaultValue = "1"),
@ApiImplicitParam(name = "pageSize", value = "页大小,最大2000，默认10", paramType = "query", defaultValue = "10"))