API接口文档

cert
schry 2 years ago
parent d8e488c6c1
commit b06ffd90f9

@ -20,6 +20,8 @@ import com.glxp.api.res.sup.UserCompanyResponse;
import com.glxp.api.service.sup.UserCompanyOnlineService;
import com.glxp.api.service.sup.UserCompanyService;
import com.glxp.api.util.DateUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@ -32,6 +34,7 @@ import java.util.List;
/**
*
*/
@Api(tags = "客户端企业信息接口")
@ApiIgnore
@RestController
@Slf4j
@ -42,6 +45,7 @@ public class UserComanyController extends BaseController {
// 关键字搜索
@ApiOperation(value = "查询用户企业信息(关键字搜索)",response = UserCompanyEntity.class)
@AuthRuleAnnotation("udi/auth/user/comapny/search")
@GetMapping("udi/auth/user/comapny/search")
public BaseResponse search(FilterUserComapanyRequest filterUserComapanyRequest) {
@ -61,6 +65,7 @@ public class UserComanyController extends BaseController {
return ResultVOUtils.success(pageSimpleResponse);
}
@ApiOperation(value = "查询用户企业信息",response = UserCompanyEntity.class)
@AuthRuleAnnotation("")
@GetMapping("udi/auth/user/comapny/filterCompanyName")
public BaseResponse filterCompanyName(FilterUserComapanyRequest filterUserComapanyRequest) {
@ -83,6 +88,7 @@ public class UserComanyController extends BaseController {
* @param filterUserComapanyRequest
* @return
*/
@ApiOperation(value = "查询企业账号列表,包含客户端在线状态",response = UserCompanyResponse.class)
@AuthRuleAnnotation("")
@GetMapping("udi/auth/user/comapny/status/filter")
public BaseResponse filterCompanyStaus(FilterUserComapanyRequest filterUserComapanyRequest) {

@ -7,6 +7,8 @@ import com.glxp.api.common.util.ResultVOUtils;
import com.glxp.api.entity.sup.UserCompanyConfigEntity;
import com.glxp.api.req.sup.UserCompanyConfigRequest;
import com.glxp.api.service.sup.UserCompanyConfigService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
@ -14,6 +16,7 @@ import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
@Api(tags = "用户企业配置相关接口")
@RestController
@Slf4j
public class UserCompanyConfigController {
@ -23,6 +26,7 @@ public class UserCompanyConfigController {
UserCompanyConfigService userCompanyConfigService;
//企业登录后获取企业任务配置
@ApiOperation(value = "企业登录后获取企业任务配置",response = UserCompanyConfigEntity.class)
@PostMapping("/admin/user/config/get")
public BaseResponse heartPost(String companyId) {
UserCompanyConfigEntity userCompanyConfigEntity = userCompanyConfigService.getOne(new QueryWrapper<UserCompanyConfigEntity>().eq("companyId", companyId));
@ -31,6 +35,7 @@ public class UserCompanyConfigController {
//编辑企业设置
@ApiOperation(value = "编辑企业设置",response = BaseResponse.class)
@PostMapping("/admin/user/config/update")
public BaseResponse updateConfig(@RequestBody UserCompanyConfigRequest userCompanyConfigRequest) {
UserCompanyConfigEntity userCompanyConfigEntity = new UserCompanyConfigEntity();

@ -8,6 +8,7 @@ import com.glxp.api.service.sup.UserCompanyOnlineService;
import com.glxp.api.util.BeanCopyUtils;
import com.glxp.api.util.IpUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
@ -31,6 +32,7 @@ public class UserOnLineController {
* @param userCompanyOnlineRequest
* @return
*/
@ApiOperation(value = "企业定时心跳,报告是否在线",response = BaseResponse.class)
@PostMapping("/admin/user/online/heart")
public BaseResponse heartPost(@RequestBody UserCompanyOnlineRequest userCompanyOnlineRequest, HttpServletRequest request) {
UserCompanyOnlineEntity userCompanyOnlineEntity = new UserCompanyOnlineEntity();

@ -23,6 +23,8 @@ import com.glxp.api.res.auth.registComPerResponse;
import com.glxp.api.service.purchase.IEmailService;
import com.glxp.api.service.sup.*;
import com.glxp.api.util.UuidUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ -46,6 +48,7 @@ import cn.hutool.core.util.StrUtil;
import lombok.extern.slf4j.Slf4j;
import springfox.documentation.annotations.ApiIgnore;
@Api(tags = "用户注册相关接口")
@ApiIgnore
@RestController
@Slf4j
@ -68,12 +71,13 @@ public class UserRegisterController extends BaseController {
@Resource
private IEmailService iEmailService;
@ApiOperation(value = "获取校验码",response = loginmobileRequest.class)
@PostMapping("/admin/auth/register/getCheckcode")
public BaseResponse getCheckcode(@RequestBody loginmobileRequest params, HttpSession httpSession) {
return CaptchaUtils.getCheckcode(params, httpSession);
}
@ApiOperation(value = "校验码",response = loginmobileRequest.class)
@PostMapping("/admin/auth/register/checkCode")
public BaseResponse checkCode(@RequestBody loginmobileRequest params) {
return CaptchaUtils.checkCode(params);
@ -84,6 +88,7 @@ public class UserRegisterController extends BaseController {
*
* @param mobile
*/
@ApiOperation(value = "根据手机号获取注册信息",response = BaseResponse.class)
@GetMapping("/admin/auth/register/get/{mobile}")
public BaseResponse getInfo(@PathVariable String mobile) {
Map<String, Object> map = new HashMap<>();
@ -105,7 +110,7 @@ public class UserRegisterController extends BaseController {
return ResultVOUtils.success(map);
}
@ApiOperation(value = "保存注册人信息",response = BaseResponse.class)
@PostMapping("/admin/auth/register/save")
public BaseResponse saveRegister(@RequestBody @Valid UserRegisterEntity userRegisterEntity, HttpSession httpSession,
BindingResult bindingResult) {
@ -140,6 +145,7 @@ public class UserRegisterController extends BaseController {
//第一次完善信息 插入默认数据
@ApiOperation(value = "第一次完善信息 插入默认数据",response = BaseResponse.class)
@GetMapping("/admin/auth/register/insertInitial")
public BaseResponse insertInitial(String mobile) {
Map<Object, Object> map = new HashMap<>();
@ -188,7 +194,7 @@ public class UserRegisterController extends BaseController {
}
@ApiOperation(value = "保存所有信息",response = BaseResponse.class)
@PostMapping("/admin/auth/register/saveAllInfo")
public BaseResponse saveAllInfo(@RequestBody registComPerResponse registComPerResponse) {
@ -219,7 +225,7 @@ public class UserRegisterController extends BaseController {
}
@ApiOperation(value = "查询注册人列表",response = registComPerResponse.class)
@PostMapping("/admin/auth/register/list")
public BaseResponse selectReslist(@RequestBody UserRegisterFilterRequest userRegisterFilterRequest, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
@ -238,6 +244,7 @@ public class UserRegisterController extends BaseController {
@Resource
UserCompanyConfigService userCompanyConfigService;
@ApiOperation(value = "无证明注册",response = BaseResponse.class)
@PostMapping("/admin/auth/register/NotApproved")
public BaseResponse NotApproved(@RequestBody registComPerResponse registComPerResponse, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
@ -310,6 +317,7 @@ public class UserRegisterController extends BaseController {
}
//对手机 验证码进行加密/解密
@ApiOperation(value = "对手机 验证码进行加密/解密",response = MobileCaptchaRequest.class)
@PostMapping("/admin/auth/register/encrypt")
public BaseResponse encrypt(@RequestBody MobileCaptchaRequest mobileCaptchaRequest) {
if (mobileCaptchaRequest == null) {

@ -13,6 +13,8 @@ import com.glxp.api.res.system.SystemPDFTemplateResponse;
import com.glxp.api.res.system.SystemPDFTemplateSelectResponse;
import com.glxp.api.service.system.SystemPDFTemplateService;
import com.glxp.api.util.JasperUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.annotation.Value;
@ -28,6 +30,7 @@ import java.io.File;
import java.util.Date;
import java.util.List;
import java.util.stream.Collectors;
@Api(tags = "系统PDF模板相关接口")
@ApiIgnore
@RestController
public class SysPdfTemplateController {
@ -38,6 +41,7 @@ public class SysPdfTemplateController {
@Value("${file_path}")
private String filePath;
@ApiOperation(value = "获取系统PDF模板列表",response = SystemPDFTemplateResponse.class)
@AuthRuleAnnotation("system/pdf/template/list")
@GetMapping("/system/pdf/template/list")
public BaseResponse list(@Valid FilterPdfTemplateRequest filterPdfTemplateRequest,

@ -8,6 +8,8 @@ import com.glxp.api.config.rabbit.TopicRabbitConfig;
import com.glxp.api.entity.trace.MqTraceMessage;
import com.glxp.api.util.DateUtil;
import com.glxp.api.util.udi.FilterUdiUtils;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.web.bind.annotation.GetMapping;
@ -21,13 +23,14 @@ import java.util.Date;
import java.util.HashMap;
import java.util.Map;
@Api(tags = "测试相关接口")
@RestController
@RequiredArgsConstructor
public class TestController {
@Resource
private final RabbitTemplate rabbitTemplate;
@ApiOperation(value = "UDI码推送接口",response = BaseResponse.class)
@GetMapping("/sendUdi")
public BaseResponse sendUdi(String key) {
String messageId = String.valueOf(UUID.randomUUID());
@ -51,6 +54,7 @@ public class TestController {
// return ResultVOUtils.success("发送成功");
// }
@ApiOperation(value = "Mq跟踪消息推送接口",response = BaseResponse.class)
@GetMapping("/sendCommon")
public BaseResponse sendCommon(@RequestBody MqTraceMessage mqTraceMessage) {
String messageId = String.valueOf(UUID.randomUUID());

@ -58,7 +58,7 @@ public class TraceManuOrderController {
@Resource
private final RabbitTemplate rabbitTemplate;
@ApiOperation(value = "生产信息推送接口",response = BaseResponse.class)
@GetMapping("udi/trace/manu/order/sendUdi")
public BaseResponse sendUdi(@RequestBody TraceManuOrderUploadRequest traceManuOrderUploadRequest) {
String messageJson = JSON.toJSONString(traceManuOrderUploadRequest);

@ -88,6 +88,7 @@ public class UdiTraceController extends BaseController {
private final RabbitTemplate rabbitTemplate;
@ApiIgnore
@ApiOperation(value = "消息推送接口",response = BaseResponse.class)
@GetMapping("/udi/trace/source/sendUDI")
public BaseResponse sendUdi(@RequestBody TraceRecordRequest traceRecordRequest) {
String messageJson = JSON.toJSONString(traceRecordRequest);
@ -96,13 +97,13 @@ public class UdiTraceController extends BaseController {
return ResultVOUtils.success("发送成功");
}
@PostMapping("/udi/trace/source/task")
/*@PostMapping("/udi/trace/source/task")
public BaseResponse sendTask(@RequestBody MqTaskDelayMessage mqTaskDelayMessage) {
String messageJson = JSON.toJSONString(mqTaskDelayMessage);
System.out.println(messageJson);
rabbitTemplate.convertAndSend(TopicRabbitConfig.TRACE_DELAY_EXCHANGE, TopicRabbitConfig.delaytrace, mqTaskDelayMessage);
return ResultVOUtils.success("发送成功");
}
}*/

@ -7,29 +7,37 @@ import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("用户企业配置实体")
@Data
@TableName(value = "user_company_config")
public class UserCompanyConfigEntity implements Serializable {
@ApiModelProperty(value = "id")
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
/**
* ID
*/
@ApiModelProperty(value = "企业ID")
@TableField(value = "companyId")
private Long companyId;
/**
* (
*/
@ApiModelProperty(value = "心跳频率(秒)")
@TableField(value = "heartRate")
private Integer heartRate;
/**
*
*/
@ApiModelProperty(value = "备注")
@TableField(value = "remark")
private String remark;

@ -8,129 +8,152 @@ import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("用户注册实体")
@Data
@TableName(value = "user_register")
public class UserRegisterEntity implements Serializable {
@ApiModelProperty(value = "id")
@TableId(value = "id", type = IdType.INPUT)
private Long id;
/**
* ID
*/
@ApiModelProperty(value = "企业信息ID")
@TableField(value = "companyId")
private Long companyId;
/**
*
*/
@ApiModelProperty(value = "真实姓名")
@TableField(value = "realName")
private String realName;
/**
* ID
*/
@ApiModelProperty(value = "用户ID")
@TableField(value = "userId")
private String userId;
/**
*
*/
@ApiModelProperty(value = "手机")
@TableField(value = "mobile")
private String mobile;
/**
*
*/
@ApiModelProperty(value = "邮箱")
@TableField(value = "email")
private String email;
/**
*
*/
@ApiModelProperty(value = "企业名称")
@TableField(value = "companyName")
private String companyName;
/**
*
*/
@ApiModelProperty(value = "统一社会信用号")
@TableField(value = "creditNum")
private String creditNum;
/**
* 1,2,3,.4.
*/
@ApiModelProperty(value = "企业类型 1生产企业,2流通企业,3,医疗机构.4.监管机构")
@TableField(value = "bussinessStatus")
private String bussinessStatus;
/**
*
*/
@ApiModelProperty(value = "注册时间")
@TableField(value = "registerTime")
private Date registerTime;
/**
*
*/
@ApiModelProperty(value = "法人名称")
@TableField(value = "legalPerson")
private String legalPerson;
/**
*
*/
@ApiModelProperty(value = "法人身份证")
@TableField(value = "legalIdCard")
private String legalIdCard;
/**
*
*/
@ApiModelProperty(value = "注册地址")
@TableField(value = "registerAddress")
private String registerAddress;
/**
*
*/
@ApiModelProperty(value = "联系方式")
@TableField(value = "contactWay")
private String contactWay;
/**
*
*/
@ApiModelProperty(value = "备注")
@TableField(value = "comments")
private String comments;
/**
* 0 /3 /1 /2
*/
@ApiModelProperty(value = "审核状态 0 未提交/3 已提交未审核/1 审核通过/2 审核未通过")
@TableField(value = "checkStatus")
private String checkStatus;
/**
*
*/
@ApiModelProperty(value = "审核时间")
@TableField(value = "checkTime")
private Date checkTime;
@ApiModelProperty(value = "用户名称")
@TableField(value = "name")
private String name;
@ApiModelProperty(value = "电话")
@TableField(value = "tel")
private String tel;
@ApiModelProperty(value = "qq")
@TableField(value = "qq")
private String qq;
@ApiModelProperty(value = "微信")
@TableField(value = "weChat")
private String weChat;
@ApiModelProperty(value = "x邮箱")
@TableField(value = "xemail")
private String xemail;
@ApiModelProperty(value = "f手机号码")
@TableField(value = "fmobile")
private String fmobile;

@ -1,12 +1,18 @@
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 FilterUserComapanyRequest extends ListPageRequest {
@ApiModelProperty(value = "查询键")
private String searchKey;
@ApiModelProperty(value = "企业名称")
private String companyName;
}

@ -1,5 +1,7 @@
package com.glxp.api.req.auth;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
@ -8,9 +10,16 @@ import lombok.Data;
* @modyified By :
*/
@Data
@ApiModel("手机验证码请求类")
public class MobileCaptchaRequest {
@ApiModelProperty(value = "手机号码")
private String mobile;
@ApiModelProperty(value = "验证码")
private String captcha;
@ApiModelProperty(value = "键")
private String key;
}

@ -2,21 +2,47 @@ 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;
@ApiModel("用户注册请求类")
@Data
public class UserRegisterFilterRequest extends ListPageRequest {
@ApiModelProperty(value = "id")
private String id;
@ApiModelProperty(value = "注册人ID")
private String registerId;
@ApiModelProperty(value = "企业ID")
private String companyId;
@ApiModelProperty(value = "企业名称")
private String companyName;
@ApiModelProperty(value = "核验状态")
private String checkStatus;
@ApiModelProperty(value = "注册人名称")
private String name;
@ApiModelProperty(value = "电话号码")
private String tel;
@ApiModelProperty(value = "手机号码")
private String mobile;
@ApiModelProperty(value = "qq")
private String qq;
@ApiModelProperty(value = "微信")
private String weChart;
@ApiModelProperty(value = "邮箱")
private String email;
@ApiModelProperty(value = "创建时间")
private String createTime;
}

@ -1,14 +1,18 @@
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;
@ApiModel("登入手机号码请求类")
@Data
public class loginmobileRequest extends ListPageRequest {
@ApiModelProperty(value = "手机号码")
private String mobile;
@ApiModelProperty(value = "校验码")
private String checkCode;
}

@ -2,26 +2,33 @@ package com.glxp.api.req.sup;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("用户企业配置请求类")
@Data
public class UserCompanyConfigRequest {
@ApiModelProperty(value = "id")
private Integer id;
/**
* ID
*/
@ApiModelProperty(value = "企业ID")
private Long companyId;
/**
* (
*/
@ApiModelProperty(value = "心跳频率(秒)")
private Integer heartRate;
/**
*
*/
@ApiModelProperty(value = "备注")
private String remark;
}

@ -1,6 +1,8 @@
package com.glxp.api.res.auth;
import com.glxp.api.entity.sup.UserCertEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.List;
@ -10,41 +12,102 @@ import java.util.List;
* @date : 2023/5/17 17:51
* @modyified By :
*/
@ApiModel("注册企业个人响应类")
@Data
public class registComPerResponse {
@ApiModelProperty(value = "id")
private String id;
@ApiModelProperty(value = "名称")
private String name;
@ApiModelProperty(value = "电话")
private String tel;
@ApiModelProperty(value = "真实姓名")
private String realName;
@ApiModelProperty(value = "qq")
private String qq;
@ApiModelProperty(value = "微信")
private String weChat;
@ApiModelProperty(value = "企业名称")
private String companyName;
//企业类型
@ApiModelProperty(value = "企业类型")
private String bussinessStatus;
@ApiModelProperty(value = "统一社会信用号")
private String creditNum;
@ApiModelProperty(value = "法人")
private String legalPerson;
@ApiModelProperty(value = "法人身份证号")
private String legalIdCard;
@ApiModelProperty(value = "注册地址")
private String registerAddress;
@ApiModelProperty(value = "联系方式")
private String contactWay;
@ApiModelProperty(value = "邮箱")
private String email;
@ApiModelProperty(value = "手机号码")
private String mobile;
@ApiModelProperty(value = "备注")
private String remark;
@ApiModelProperty(value = "upId")
private String upId;
@ApiModelProperty(value = "urId")
private String urId;
@ApiModelProperty(value = "ucId")
private String ucId;
@ApiModelProperty(value = "用户资质列表")
private List<UserCertEntity> list;
@ApiModelProperty(value = "键")
private String key;
@ApiModelProperty(value = "核验状态")
private String checkStatus;
@ApiModelProperty(value = "uc状态")
private String ucstatus;
@ApiModelProperty(value = "x邮箱")
private String xemail;
@ApiModelProperty(value = "企业说明")
private String reason; //企业说明
@ApiModelProperty(value = "f手机号码")
private String fmobile;
@ApiModelProperty(value = "审核人")
private String reviewer; //审核人
@ApiModelProperty(value = "资质审核说明")
private String checkComment;//资质审核说明
@ApiModelProperty(value = "是否通过")
private String isPass;
@ApiModelProperty(value = "资质名称")
private String certName;
@ApiModelProperty(value = "注册时间")
private String registerTime;

@ -2,25 +2,33 @@ package com.glxp.api.res.sup;
import com.baomidou.mybatisplus.annotation.TableField;
import com.glxp.api.entity.sup.UserCompanyEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.Date;
@Data
@ApiModel("用户企业响应类")
public class UserCompanyResponse extends UserCompanyEntity {
@ApiModelProperty(value = "用户ID")
private Long userId;
@ApiModelProperty(value = "更新时间")
private Date updateTime;
@ApiModelProperty(value = "心跳频率(秒)")
private Long heartRate;
/**
* 线 1线2线; 3:
*/
@ApiModelProperty(value = "在线状态 1在线2离线; 3:未注册")
private Integer onLineStatus;
@ApiModelProperty(value = "最后登入IP")
private String lastIp;
@ApiModelProperty(value = "备注")
private String remark;
}

@ -1,22 +1,48 @@
package com.glxp.api.res.system;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.util.Date;
@Data
@ApiModel("系统PDF模板响应类")
public class SystemPDFTemplateResponse {
@ApiModelProperty(value = "id")
private int id;
@ApiModelProperty(value = "模板名称")
private String name;
@ApiModelProperty(value = "类型")
private int type;
@ApiModelProperty(value = "")
private int module;
@ApiModelProperty(value = "参数")
private String param;
@ApiModelProperty(value = "路径")
private String path;
@ApiModelProperty(value = "")
private int rowCount;
@ApiModelProperty(value = "")
private int qrcodeCount;
@ApiModelProperty(value = "")
private String remark;
@ApiModelProperty(value = "")
private Date create_time;
@ApiModelProperty(value = "")
private Date update_time;
@ApiModelProperty(value = "")
private String jrxmlPath;
}
Loading…
Cancel
Save