Skip to content
GitLab
Commit 496865c8 authored by yurong's avatar yurong
Browse files

运营平台完善knife4j接口描述

parent 1fd61f3e
Hide whitespace changes
Inline Side-by-side
jeepay-manager/src/main/java/com/jeequan/jeepay/mgr/ctrl/sysuser/SysRoleController.java
View file @ 496865c8
......@@ -24,6 +24,7 @@ import com.jeequan.jeepay.core.constants.CS;
import com.jeequan.jeepay.core.entity.SysRole;
import com.jeequan.jeepay.core.entity.SysUserRoleRela;
import com.jeequan.jeepay.core.exception.BizException;
import com.jeequan.jeepay.core.model.ApiPageRes;
import com.jeequan.jeepay.mgr.service.AuthService;
import com.jeequan.jeepay.service.impl.SysRoleEntRelaService;
import com.jeequan.jeepay.service.impl.SysRoleService;
......@@ -31,6 +32,10 @@ import com.jeequan.jeepay.service.impl.SysUserRoleRelaService;
import com.jeequan.jeepay.core.utils.StringKit;
import com.jeequan.jeepay.core.model.ApiRes;
import com.jeequan.jeepay.mgr.ctrl.CommonCtrl;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.MutablePair;
import org.springframework.beans.factory.annotation.Autowired;
......@@ -51,6 +56,7 @@ import java.util.List;
* @site https://www.jeequan.com
* @date 2021/6/8 17:13
*/
@Api(tags = "系统管理（用户角色）")
@RestController
@RequestMapping("api/sysRoles")
public class SysRoleController extends CommonCtrl {
......@@ -62,9 +68,17 @@ public class SysRoleController extends CommonCtrl {
/** list */
@ApiOperation("角色列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "pageNumber", value = "分页页码", dataType = "int", defaultValue = "1"),
@ApiImplicitParam(name = "pageSize", value = "分页条数（-1时查全部数据）", dataType = "int", defaultValue = "20"),
@ApiImplicitParam(name = "roleId", value = "角色ID, ROLE_开头"),
@ApiImplicitParam(name = "roleName", value = "角色名称")
})
@PreAuthorize("hasAnyAuthority( 'ENT_UR_ROLE_LIST', 'ENT_UR_USER_UPD_ROLE' )")
@RequestMapping(value="", method = RequestMethod.GET)
public ApiRes list() {
public ApiPageRes<SysRole> list() {
SysRole queryObject = getObject(SysRole.class);
......@@ -90,11 +104,16 @@ public class SysRoleController extends CommonCtrl {
}
IPage<SysRole> pages = sysRoleService.page(getIPage(true), condition);
return ApiRes.page(pages);
return ApiPageRes.pages(pages);
}
/** detail */
@ApiOperation("角色详情")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "角色ID, ROLE_开头", required = true)
})
@PreAuthorize("hasAuthority( 'ENT_UR_ROLE_EDIT' )")
@RequestMapping(value="/{recordId}", method = RequestMethod.GET)
public ApiRes detail(@PathVariable("recordId") String recordId) {
......@@ -102,6 +121,12 @@ public class SysRoleController extends CommonCtrl {
}
/** add */
@ApiOperation("添加角色信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "roleName", value = "角色名称", required = true),
@ApiImplicitParam(name = "entIdListStr", value = "权限信息集合，eg：[str1,str2]，字符串列表转成json字符串，若为空，则创建的角色无任何权限")
})
@PreAuthorize("hasAuthority( 'ENT_UR_ROLE_ADD' )")
@MethodLog(remark = "添加角色信息")
@RequestMapping(value="", method = RequestMethod.POST)
......@@ -127,6 +152,13 @@ public class SysRoleController extends CommonCtrl {
}
/** update */
@ApiOperation("更新角色信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "角色ID, ROLE_开头", required = true),
@ApiImplicitParam(name = "roleName", value = "角色名称", required = true),
@ApiImplicitParam(name = "entIdListStr", value = "权限信息集合，eg：[str1,str2]，字符串列表转成json字符串，若为空，则创建的角色无任何权限")
})
@PreAuthorize("hasAuthority( 'ENT_UR_ROLE_EDIT' )")
@RequestMapping(value="/{recordId}", method = RequestMethod.PUT)
@MethodLog(remark = "更新角色信息")
......@@ -156,6 +188,11 @@ public class SysRoleController extends CommonCtrl {
}
/** delete */
@ApiOperation("删除角色")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "角色ID, ROLE_开头", required = true)
})
@PreAuthorize("hasAuthority('ENT_UR_ROLE_DEL')")
@MethodLog(remark = "删除角色")
@RequestMapping(value="/{recordId}", method = RequestMethod.DELETE)
......
jeepay-manager/src/main/java/com/jeequan/jeepay/mgr/ctrl/sysuser/SysRoleEntRelaController.java
View file @ 496865c8
......@@ -18,11 +18,13 @@ package com.jeequan.jeepay.mgr.ctrl.sysuser;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.jeequan.jeepay.core.entity.SysRoleEntRela;
import com.jeequan.jeepay.core.model.ApiRes;
import com.jeequan.jeepay.core.model.ApiPageRes;
import com.jeequan.jeepay.mgr.ctrl.CommonCtrl;
import com.jeequan.jeepay.mgr.service.AuthService;
import com.jeequan.jeepay.service.impl.SysRoleEntRelaService;
import com.jeequan.jeepay.service.impl.SysUserRoleRelaService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.RequestMapping;
......@@ -36,6 +38,7 @@ import org.springframework.web.bind.annotation.RestController;
* @site https://www.jeequan.com
* @date 2021/6/8 17:13
*/
@Api(tags = "系统管理（用户-角色-权限关联信息）")
@RestController
@RequestMapping("api/sysRoleEntRelas")
public class SysRoleEntRelaController extends CommonCtrl {
......@@ -43,9 +46,16 @@ public class SysRoleEntRelaController extends CommonCtrl {
@Autowired private SysRoleEntRelaService sysRoleEntRelaService;
/** list */
@ApiOperation("关联关系--角色-权限关联信息列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "pageNumber", value = "分页页码", dataType = "int", defaultValue = "1"),
@ApiImplicitParam(name = "pageSize", value = "分页条数（-1时查全部数据）", dataType = "int", defaultValue = "20"),
@ApiImplicitParam(name = "roleId", value = "角色ID, ROLE_开头")
})
@PreAuthorize("hasAnyAuthority( 'ENT_UR_ROLE_ADD', 'ENT_UR_ROLE_DIST' )")
@RequestMapping(value="", method = RequestMethod.GET)
public ApiRes list() {
public ApiPageRes<SysRoleEntRela> list() {
SysRoleEntRela queryObject = getObject(SysRoleEntRela.class);
......@@ -57,7 +67,7 @@ public class SysRoleEntRelaController extends CommonCtrl {
IPage<SysRoleEntRela> pages = sysRoleEntRelaService.page(getIPage(true), condition);
return ApiRes.page(pages);
return ApiPageRes.pages(pages);
}
}
jeepay-manager/src/main/java/com/jeequan/jeepay/mgr/ctrl/sysuser/SysUserController.java
View file @ 496865c8
......@@ -22,11 +22,16 @@ import com.jeequan.jeepay.core.aop.MethodLog;
import com.jeequan.jeepay.core.constants.CS;
import com.jeequan.jeepay.core.entity.SysUser;
import com.jeequan.jeepay.core.exception.BizException;
import com.jeequan.jeepay.core.model.ApiPageRes;
import com.jeequan.jeepay.core.model.ApiRes;
import com.jeequan.jeepay.mgr.ctrl.CommonCtrl;
import com.jeequan.jeepay.mgr.service.AuthService;
import com.jeequan.jeepay.service.impl.SysUserAuthService;
import com.jeequan.jeepay.service.impl.SysUserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
......@@ -44,6 +49,7 @@ import java.util.Arrays;
* @site https://www.jeequan.com
* @date 2021/6/8 17:13
*/
@Api(tags = "系统管理（操作员）")
@RestController
@RequestMapping("api/sysUsers")
public class SysUserController extends CommonCtrl {
......@@ -53,9 +59,17 @@ public class SysUserController extends CommonCtrl {
@Autowired private AuthService authService;
/** list */
@ApiOperation("操作员列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "pageNumber", value = "分页页码", dataType = "int", defaultValue = "1"),
@ApiImplicitParam(name = "pageSize", value = "分页条数", dataType = "int", defaultValue = "20"),
@ApiImplicitParam(name = "sysUserId", value = "用户ID"),
@ApiImplicitParam(name = "realname", value = "用户姓名")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_LIST' )")
@RequestMapping(value="", method = RequestMethod.GET)
public ApiRes list() {
public ApiPageRes<SysUser> list() {
SysUser queryObject = getObject(SysUser.class);
......@@ -74,20 +88,36 @@ public class SysUserController extends CommonCtrl {
IPage<SysUser> pages = sysUserService.page(getIPage(), condition);
return ApiRes.page(pages);
return ApiPageRes.pages(pages);
}
/** detail */
@ApiOperation("操作员详情")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "用户ID", required = true, dataType = "Long")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_EDIT' )")
@RequestMapping(value="/{recordId}", method = RequestMethod.GET)
public ApiRes detail(@PathVariable("recordId") Integer recordId) {
public ApiRes detail(@PathVariable("recordId") Long recordId) {
return ApiRes.ok(sysUserService.getById(recordId));
}
/** add */
@ApiOperation("添加操作员")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "isAdmin", value = "是否超管（超管拥有全部权限） 0-否 1-是", required = true, dataType = "Byte"),
@ApiImplicitParam(name = "loginUsername", value = "登录用户名", required = true),
@ApiImplicitParam(name = "realname", value = "真实姓名", required = true),
@ApiImplicitParam(name = "sex", value = "性别 0-未知, 1-男, 2-女", required = true, dataType = "Byte"),
@ApiImplicitParam(name = "telphone", value = "手机号", required = true),
@ApiImplicitParam(name = "userNo", value = "员工编号", required = true),
@ApiImplicitParam(name = "state", value = "状态: 0-停用, 1-启用", required = true, dataType = "Byte")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_ADD' )")
@MethodLog(remark = "添加管理员")
@MethodLog(remark = "添加操作员")
@RequestMapping(value="", method = RequestMethod.POST)
public ApiRes add() {
SysUser sysUser = getObject(SysUser.class);
......@@ -125,6 +155,21 @@ public class SysUserController extends CommonCtrl {
/** update */
@ApiOperation("修改操作员信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "用户ID", required = true, dataType = "Long"),
@ApiImplicitParam(name = "isAdmin", value = "是否超管（超管拥有全部权限） 0-否 1-是", required = true, dataType = "Byte"),
@ApiImplicitParam(name = "loginUsername", value = "登录用户名", required = true),
@ApiImplicitParam(name = "realname", value = "真实姓名", required = true),
@ApiImplicitParam(name = "sex", value = "性别 0-未知, 1-男, 2-女", required = true, dataType = "Byte"),
@ApiImplicitParam(name = "telphone", value = "手机号", required = true),
@ApiImplicitParam(name = "userNo", value = "员工编号", required = true),
@ApiImplicitParam(name = "state", value = "状态: 0-停用, 1-启用", required = true, dataType = "Byte"),
@ApiImplicitParam(name = "resetPass", value = "是否重置密码", dataType = "Boolean"),
@ApiImplicitParam(name = "confirmPwd", value = "待更新的密码，base64加密"),
@ApiImplicitParam(name = "defaultPass", value = "是否默认密码", dataType = "Boolean")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_EDIT' )")
@RequestMapping(value="/{recordId}", method = RequestMethod.PUT)
@MethodLog(remark = "修改操作员信息")
......@@ -154,6 +199,11 @@ public class SysUserController extends CommonCtrl {
}
/** delete */
@ApiOperation("删除操作员信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "recordId", value = "用户ID", required = true, dataType = "Long")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_DELETE' )")
@RequestMapping(value="/{recordId}", method = RequestMethod.DELETE)
@MethodLog(remark = "删除操作员信息")
......
jeepay-manager/src/main/java/com/jeequan/jeepay/mgr/ctrl/sysuser/SysUserRoleRelaController.java
View file @ 496865c8
......@@ -20,11 +20,16 @@ import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.jeequan.jeepay.core.aop.MethodLog;
import com.jeequan.jeepay.core.entity.SysUserRoleRela;
import com.jeequan.jeepay.core.model.ApiPageRes;
import com.jeequan.jeepay.core.model.ApiRes;
import com.jeequan.jeepay.mgr.ctrl.CommonCtrl;
import com.jeequan.jeepay.mgr.service.AuthService;
import com.jeequan.jeepay.service.impl.SysUserRoleRelaService;
import com.jeequan.jeepay.service.impl.SysUserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.PathVariable;
......@@ -42,6 +47,7 @@ import java.util.List;
* @site https://www.jeequan.com
* @date 2021/6/8 17:13
*/
@Api(tags = "系统管理（用户-角色-权限关联信息）")
@RestController
@RequestMapping("api/sysUserRoleRelas")
public class SysUserRoleRelaController extends CommonCtrl {
......@@ -51,9 +57,16 @@ public class SysUserRoleRelaController extends CommonCtrl {
@Autowired private AuthService authService;
/** list */
@ApiOperation("关联关系--用户-角色关联信息列表")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "pageNumber", value = "分页页码", dataType = "int", defaultValue = "1"),
@ApiImplicitParam(name = "pageSize", value = "分页条数（-1时查全部数据）", dataType = "int", defaultValue = "20"),
@ApiImplicitParam(name = "userId", value = "用户ID")
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_UPD_ROLE' )")
@RequestMapping(value="", method = RequestMethod.GET)
public ApiRes list() {
public ApiPageRes<SysUserRoleRela> list() {
SysUserRoleRela queryObject = getObject(SysUserRoleRela.class);
......@@ -65,10 +78,16 @@ public class SysUserRoleRelaController extends CommonCtrl {
IPage<SysUserRoleRela> pages = sysUserRoleRelaService.page(getIPage(true), condition);
return ApiRes.page(pages);
return ApiPageRes.pages(pages);
}
/** 重置用户角色关联信息 */
@ApiOperation("更改用户角色信息")
@ApiImplicitParams({
@ApiImplicitParam(name = "iToken", value = "用户身份凭证", required = true, paramType = "header"),
@ApiImplicitParam(name = "sysUserId", value = "用户ID", required = true),
@ApiImplicitParam(name = "roleIdListStr", value = "角色信息，eg：[str1,str2]，字符串列表转成json字符串", required = true)
})
@PreAuthorize("hasAuthority( 'ENT_UR_USER_UPD_ROLE' )")
@RequestMapping(value="relas/{sysUserId}", method = RequestMethod.POST)
@MethodLog(remark = "更改用户角色信息")
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment