接口文档整理

cert
schry 2 years ago
parent b99d015e50
commit 6799759a08

@ -10,6 +10,7 @@ import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.validation.Valid;
import com.glxp.api.entity.auth.*;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.BeanUtils;
@ -26,10 +27,6 @@ import com.glxp.api.common.util.ResultVOUtils;
import com.glxp.api.constant.Constant;
import com.glxp.api.controller.BaseController;
import com.glxp.api.dao.auth.AuthLicenseDao;
import com.glxp.api.entity.auth.AuthAdmin;
import com.glxp.api.entity.auth.AuthCheckEntity;
import com.glxp.api.entity.auth.SysMenu;
import com.glxp.api.entity.auth.SysRole;
import com.glxp.api.entity.system.CompanyEntity;
import com.glxp.api.entity.system.SysPdaKeyEntity;
import com.glxp.api.exception.JsonException;
@ -253,6 +250,7 @@ public class LoginController extends BaseController {
ISysMenuService menuService;
@ApiIgnore
@ApiOperation(value = "获取路由信息",response = RouterEntity.class)
@GetMapping("/spms/getRouters")
public BaseResponse getRouters() {
AuthAdmin authAdmin = getUser();
@ -265,7 +263,7 @@ public class LoginController extends BaseController {
*
* @return
*/
@ApiOperation("系统用户登出")
@ApiOperation(value = "系统用户登出",response = BaseResponse.class)
@PostMapping("/admin/auth/login/out")
public BaseResponse out() {
return ResultVOUtils.success();
@ -277,6 +275,7 @@ public class LoginController extends BaseController {
* @return
*/
@ApiIgnore
@ApiOperation(value = "修改密码",response = BaseResponse.class)
@AuthRuleAnnotation("") // 需要登录验证,但是不需要权限验证时,value 值填空字符串
@PostMapping("/admin/auth/login/password")
public BaseResponse password(@RequestBody @Valid UpdatePasswordRequest updatePasswordRequest,

@ -9,6 +9,8 @@ import com.glxp.api.service.auth.ISysDictDataService;
import com.glxp.api.service.auth.ISysDictTypeService;
import com.glxp.api.common.res.BaseResponse;
import com.glxp.api.common.util.ResultVOUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@ -21,6 +23,7 @@ import java.util.List;
*
*/
@Api(tags = "数据字典信息相关接口")
@ApiIgnore
@Validated
@RequiredArgsConstructor
@ -34,6 +37,7 @@ public class SysDictDataController extends BaseController {
/**
*
*/
@ApiOperation(value = "查询字典数据列表",response = SysDictData.class)
@GetMapping("/list")
public BaseResponse list(SysDictDataRequest sysDictDataRequest) {
@ -46,6 +50,7 @@ public class SysDictDataController extends BaseController {
*
* @param dictCode code
*/
@ApiOperation(value = "查询字典数据详细",response = SysDictData.class)
@GetMapping(value = "/{dictCode}")
public BaseResponse getInfo(@PathVariable Long dictCode) {
return ResultVOUtils.success(dictDataService.selectDictDataById(dictCode));
@ -56,6 +61,7 @@ public class SysDictDataController extends BaseController {
*
* @param dictType
*/
@ApiOperation(value = "根据字典类型查询字典数据信息",response = SysDictData.class)
@GetMapping(value = "/type/{dictType}")
public BaseResponse dictType(@PathVariable String dictType) {
List<SysDictData> data = dictTypeService.selectDictDataByType(dictType);
@ -68,6 +74,7 @@ public class SysDictDataController extends BaseController {
/**
*
*/
@ApiOperation(value = "新增字典类型",response = BaseResponse.class)
@PostMapping
public BaseResponse add(@Validated @RequestBody SysDictData dict) {
dictDataService.insertDictData(dict);
@ -77,6 +84,7 @@ public class SysDictDataController extends BaseController {
/**
*
*/
@ApiOperation(value = "修改保存字典类型",response = BaseResponse.class)
@SaCheckPermission("system:dict:edit")
@PutMapping
public BaseResponse edit(@Validated @RequestBody SysDictData dict) {
@ -89,6 +97,7 @@ public class SysDictDataController extends BaseController {
*
* @param dictCodes code
*/
@ApiOperation(value = "删除字典类型",response = BaseResponse.class)
@SaCheckPermission("system:dict:remove")
@DeleteMapping("/{dictCodes}")
public BaseResponse remove(@PathVariable Long[] dictCodes) {

@ -11,6 +11,8 @@ import com.glxp.api.res.PageSimpleResponse;
import com.glxp.api.service.auth.ISysDictTypeService;
import com.glxp.api.common.res.BaseResponse;
import com.glxp.api.common.util.ResultVOUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
@ -21,7 +23,7 @@ import java.util.List;
/**
*
*/
@Api(tags = "数据字典类型相关接口")
@ApiIgnore
@RestController
@RequestMapping("/system/dict/type")
@ -32,6 +34,7 @@ public class SysDictTypeController extends BaseController {
/**
*
*/
@ApiOperation(value = "查询字典类型列表",response = SysDictType.class)
@SaCheckPermission("system:dict:list")
@GetMapping("/list")
public BaseResponse list(SysDictTypeRequest sysDictTypeRequest) {
@ -48,6 +51,7 @@ public class SysDictTypeController extends BaseController {
*
* @param dictId ID
*/
@ApiOperation(value = "查询字典类型详细",response = SysDictType.class)
@GetMapping(value = "/{dictId}")
public BaseResponse getInfo(@PathVariable Long dictId) {
return ResultVOUtils.success(dictTypeService.selectDictTypeById(dictId));
@ -56,6 +60,7 @@ public class SysDictTypeController extends BaseController {
/**
*
*/
@ApiOperation(value = "新增字典类型",response = BaseResponse.class)
@PostMapping
public BaseResponse add(@Validated @RequestBody SysDictType dict) {
if (Constant.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict))) {
@ -68,6 +73,7 @@ public class SysDictTypeController extends BaseController {
/**
*
*/
@ApiOperation(value = "修改字典类型",response = BaseResponse.class)
@PutMapping
public BaseResponse edit(@Validated @RequestBody SysDictType dict) {
// if (Constant.NOT_UNIQUE.equals(dictTypeService.checkDictTypeUnique(dict))) {
@ -82,6 +88,7 @@ public class SysDictTypeController extends BaseController {
*
* @param dictIds ID
*/
@ApiOperation(value = "删除字典类型",response = BaseResponse.class)
@SaCheckPermission("system:dict:remove")
@DeleteMapping("/{dictIds}")
public BaseResponse remove(@PathVariable Long[] dictIds) {
@ -93,6 +100,7 @@ public class SysDictTypeController extends BaseController {
/**
*
*/
@ApiOperation(value = "获取字典选择框列表",response = SysDictType.class)
@GetMapping("/optionselect")
public BaseResponse optionselect() {
List<SysDictType> dictTypes = dictTypeService.selectDictTypeAll();

@ -10,6 +10,8 @@ import com.glxp.api.service.auth.CustomerService;
import com.glxp.api.service.auth.ISysMenuService;
import com.glxp.api.common.res.BaseResponse;
import com.glxp.api.common.util.ResultVOUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
@ -25,7 +27,7 @@ import java.util.Map;
*
* @author Lion Li
*/
@Api(tags = "菜单信息相关接口")
@ApiIgnore
@RestController
@RequestMapping("/system/menu")
@ -41,6 +43,7 @@ public class SysMenuController extends BaseController {
/**
*
*/
@ApiOperation(value = "获取菜单列表",response = SysMenu.class)
@GetMapping("/list")
public BaseResponse list(SysMenu menu) {
AuthAdmin authAdmin = customerService.getUserBean();
@ -53,6 +56,7 @@ public class SysMenuController extends BaseController {
*
* @param menuId ID
*/
@ApiOperation(value = "根据菜单编号获取详细信息",response = SysMenu.class)
@GetMapping(value = "/{menuId}")
public BaseResponse getInfo(@PathVariable Long menuId) {
return ResultVOUtils.success(menuService.selectMenuById(menuId));
@ -61,6 +65,7 @@ public class SysMenuController extends BaseController {
/**
*
*/
@ApiOperation(value = "获取菜单下拉树列表",response = SysMenu.class)
@GetMapping("/treeselect")
public BaseResponse treeselect(SysMenu menu) {
AuthAdmin authAdmin = customerService.getUserBean();
@ -74,6 +79,7 @@ public class SysMenuController extends BaseController {
*
* @param roleId ID
*/
@ApiOperation(value = "加载对应角色菜单列表树",response = BaseResponse.class)
@GetMapping(value = "/roleMenuTreeselect/{roleId}")
public BaseResponse roleMenuTreeselect(@PathVariable("roleId") Long roleId) {
AuthAdmin authAdmin = customerService.getUserBean();
@ -87,6 +93,7 @@ public class SysMenuController extends BaseController {
/**
*
*/
@ApiOperation(value = "新增菜单",response = BaseResponse.class)
@PostMapping
public BaseResponse add(@Validated @RequestBody SysMenu menu) {
if (Constant.NOT_UNIQUE.equals(menuService.checkMenuNameUnique(menu))) {
@ -103,6 +110,7 @@ public class SysMenuController extends BaseController {
/**
*
*/
@ApiOperation(value = "修改菜单",response = BaseResponse.class)
@PutMapping
public BaseResponse edit(@Validated @RequestBody SysMenu menu) {
menu.setNeMenuId(menu.getMenuId());
@ -122,6 +130,7 @@ public class SysMenuController extends BaseController {
*
* @param menuId ID
*/
@ApiOperation(value = "删除菜单",response = BaseResponse.class)
@DeleteMapping("/{menuId}")
public BaseResponse remove(@PathVariable("menuId") Long menuId) {
if (menuService.hasChildByMenuId(menuId)) {
@ -133,7 +142,7 @@ public class SysMenuController extends BaseController {
menuService.deleteMenuById(menuId);
return ResultVOUtils.success("修改成功!");
return ResultVOUtils.success("删除成功!");
}

@ -14,6 +14,8 @@ import com.glxp.api.service.auth.AuthAdminService;
import com.glxp.api.service.auth.ISysRoleService;
import com.glxp.api.common.res.BaseResponse;
import com.glxp.api.common.util.ResultVOUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@ -24,6 +26,7 @@ import java.util.Date;
import java.util.List;
import java.util.UUID;
@Api(tags = "角色信息相关接口")
@ApiIgnore
@Validated
@RequiredArgsConstructor
@ -38,6 +41,7 @@ public class SysRoleController extends BaseController {
/**
*
*/
@ApiOperation(value = "获取角色信息列表",response = SysRole.class)
@GetMapping("/list")
public BaseResponse list(FilterRoleRequest filterRoleRequest) {

@ -1,5 +1,7 @@
package com.glxp.api.entity.auth;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.List;
@ -8,51 +10,61 @@ import java.util.List;
*
*/
@Data
@ApiModel("路由配置信息实体")
public class RouterEntity {
/**
*
*/
@ApiModelProperty(value = "路由名字")
private String name;
/**
*
*/
@ApiModelProperty(value = "路由地址")
private String path;
/**
* true
*/
@ApiModelProperty(value = "是否隐藏路由,当设置 true 的时候该路由不会再侧边栏出现")
private boolean hidden;
/**
* noRedirect
*/
@ApiModelProperty(value = "重定向地址,当设置 noRedirect 的时候该路由在面包屑导航中不可被点击")
private String redirect;
/**
*
*/
@ApiModelProperty(value = "组件地址")
private String component;
/**
* {"id": 1, "name": "ry"}
*/
@ApiModelProperty(value = "路由参数:如 {\"id\": 1, \"name\": \"ry\"}")
private String query;
/**
* children 1--
*/
@ApiModelProperty(value = "当你一个路由下面的 children 声明的路由大于1个时自动会变成嵌套的模式--如组件页面")
private Boolean alwaysShow;
/**
*
*/
@ApiModelProperty(value = "其他元素")
private MetaEntity meta;
/**
*
*/
@ApiModelProperty(value = "子路由")
private List<RouterEntity> children;
}

@ -2,6 +2,8 @@ package com.glxp.api.entity.auth;
import com.glxp.api.constant.Constant;
import com.glxp.api.entity.BaseEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotBlank;
@ -12,27 +14,32 @@ import javax.validation.constraints.Size;
*/
@Data
@ApiModel("字典数据实体")
public class SysDictData extends BaseEntity {
/**
*
*/
@ApiModelProperty(value = "字典编码")
private Long dictCode;
/**
*
*/
@ApiModelProperty(value = "字典排序")
private Integer dictSort;
/**
*
*/
@ApiModelProperty(value = "字典标签")
@Size(min = 0, max = 100, message = "字典标签长度不能超过100个字符")
private String dictLabel;
/**
*
*/
@ApiModelProperty(value = "字典键值")
@NotBlank(message = "字典键值不能为空")
@Size(min = 0, max = 100, message = "字典键值长度不能超过100个字符")
private String dictValue;
@ -40,6 +47,7 @@ public class SysDictData extends BaseEntity {
/**
*
*/
@ApiModelProperty(value = "字典类型")
@NotBlank(message = "字典类型不能为空")
@Size(min = 0, max = 100, message = "字典类型长度不能超过100个字符")
private String dictType;
@ -47,27 +55,32 @@ public class SysDictData extends BaseEntity {
/**
*
*/
@ApiModelProperty(value = "样式属性(其他样式扩展)")
@Size(min = 0, max = 100, message = "样式属性长度不能超过100个字符")
private String cssClass;
/**
*
*/
@ApiModelProperty(value = "表格字典样式")
private String listClass;
/**
* Y N
*/
@ApiModelProperty(value = "是否默认Y是 N否")
private String isDefault;
/**
* 0 1
*/
@ApiModelProperty(value = "状态0正常 1停用")
private String status;
/**
*
*/
@ApiModelProperty(value = "备注")
private String remark;
public boolean getDefault() {

@ -1,6 +1,8 @@
package com.glxp.api.entity.auth;
import com.glxp.api.entity.BaseEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.Pattern;
@ -9,24 +11,27 @@ import javax.validation.constraints.Size;
/**
* sys_dict_type
*/
@ApiModel("字典类型实体")
@Data
public class SysDictType extends BaseEntity {
/**
*
*/
@ApiModelProperty(value = "字典主键")
private Long dictId;
/**
*
*/
@ApiModelProperty(value = "字典名称")
@Size(min = 0, max = 100, message = "字典类型名称长度不能超过100个字符")
private String dictName;
/**
*
*/
@ApiModelProperty(value = "字典类型")
@Size(min = 0, max = 100, message = "字典类型类型长度不能超过100个字符")
@Pattern(regexp = "^[a-z][a-z0-9_]*$", message = "字典类型必须以字母开头,且只能为(小写字母,数字,下滑线)")
private String dictType;
@ -34,11 +39,13 @@ public class SysDictType extends BaseEntity {
/**
* 0 1
*/
@ApiModelProperty(value = "状态0正常 1停用")
private String status;
/**
*
*/
@ApiModelProperty(value = "备注")
private String remark;
}

@ -1,9 +1,11 @@
package com.glxp.api.entity.auth;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
@ApiModel("菜单实体")
@Data
@EqualsAndHashCode(callSuper = true)
public class SysMenu extends TreeEntity<SysMenu> {
@ -11,74 +13,88 @@ public class SysMenu extends TreeEntity<SysMenu> {
/**
* ID
*/
@ApiModelProperty(value = "菜单ID")
private Long menuId;
/**
*
*/
@ApiModelProperty(value = "菜单名称")
private String menuName;
/**
*
*/
@ApiModelProperty(value = "显示顺序")
private Integer orderNum;
/**
*
*/
@ApiModelProperty(value = "路由地址")
private String path;
/**
*
*/
@ApiModelProperty(value = "组件路径")
private String component;
/**
*
*/
@ApiModelProperty(value = "路由参数")
private String queryParam;
/**
* 0 1
*/
@ApiModelProperty(value = "是否为外链0是 1否")
private String isFrame;
/**
* 0 1
*/
@ApiModelProperty(value = "是否缓存0缓存 1不缓存")
private String isCache;
/**
* M C F
*/
@ApiModelProperty(value = "类型M目录 C菜单 F按钮")
private String menuType;
/**
* 0 1
*/
@ApiModelProperty(value = "显示状态0显示 1隐藏")
private String visible;
/**
* 0 1
*/
@ApiModelProperty(value = "菜单状态0正常 1停用")
private String status;
/**
*
*/
@ApiModelProperty(value = "权限字符串")
private String perms;
/**
*
*/
@ApiModelProperty(value = "菜单图标")
private String icon;
/**
*
*/
@ApiModelProperty(value = "备注")
private String remark;
@ApiModelProperty(value = "ne菜单ID")
private Long neMenuId;
}

@ -1,14 +1,24 @@
package com.glxp.api.req.auth;
import com.glxp.api.util.page.ListPageRequest;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("数据字典请求类")
public class SysDictDataRequest extends ListPageRequest {
@ApiModelProperty(value = "字典类型")
private String dictType;
@ApiModelProperty(value = "状态0正常 1停用")
private String status;
@ApiModelProperty(value = "字典标签")
private String dictLabel;
@ApiModelProperty(value = "字典键值")
private String dictValue;
}

@ -1,16 +1,23 @@
package com.glxp.api.req.auth;
import com.glxp.api.util.page.ListPageRequest;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("字典类型请求类")
public class SysDictTypeRequest extends ListPageRequest {
@ApiModelProperty(value = "字典主键")
private Long dictId;
@ApiModelProperty(value = "字典名称")
private String dictName;
@ApiModelProperty(value = "字典类型")
private String dictType;
@ApiModelProperty(value = "状态0正常 1停用")
private String status;
}

@ -1,5 +1,7 @@
package com.glxp.api.res.auth;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.List;
@ -9,24 +11,45 @@ import java.util.Set;
*
*/
@Data
@ApiModel("登录用户的信息视图响应类")
public class LoginUserInfoResponse {
@ApiModelProperty(value = "id")
private Long id;
@ApiModelProperty(value = "用户名称")
private String userName;
@ApiModelProperty(value = "")
private String avatar;
@ApiModelProperty(value = "员工名称")
private String employeeName;
// 权限列表
@ApiModelProperty(value = "权限列表")
private List<String> authRules;
@ApiModelProperty(value = "本地部门编码")
private String locDeptCode;
@ApiModelProperty(value = "本地仓库编码")
private String locInvCode;
@ApiModelProperty(value = "本地部门名称")
private String locDeptName;
@ApiModelProperty(value = "本地仓库名称")
private String locInvName;
@ApiModelProperty(value = "用户角色")
Set<String> roles; //用户角色
Set<String> permissions; //用户权限
@ApiModelProperty(value = "用户权限")
Set<String> permissions; //用户权限
@ApiModelProperty(value = "客户id")
private String CustomerId;
@ApiModelProperty(value = "企业名称")
private String companyName;
}

Loading…
Cancel
Save