Skip to content

E
easy-affair-show
Commit e2217e79 authored by 廖旭伟's avatar 廖旭伟
Browse files
Options

前台接口文档

parent eb4e2865
Hide whitespace changes
Inline Side-by-side
Showing with 527 additions and 0 deletions
eas-manager/doc/api.md
View file @ e2217e79
......@@ -3478,4 +3478,529 @@ msg|String|消息|-
"msg":"成功"
}
```
## 前台接口
### 用户登录
**请求URL:** customer/login/login
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 用户登录
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
loginName|String|是|登录名
password|String|是|密码
**请求样例:**
```
{
"loginName": "test",
"password": "admin"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 token|String|登录凭证
 customer|object|客户信息实体
  id|Long|主键ID，主键，自增长
  loginName|String|用户登录账号
  password|String|密码
  memberLevel|Integer|会员等级，，0：未开启，1：试用客户，2：VIP，3：设计师，默认0
  custName|String|客户真实名称
  organization|String|单位名称
  contactTelphone|String|联系电话
  enterpriseConsultant|String|企业顾问
  siteId|Long|站点ID
  sex|Integer|性别
  mailbox|String|邮箱
  job|String|职位
  customerSrc|Long|客户来源
  status|Integer|使用状态，1:正常，0:禁用，默认：0
  createUserId|Long|创建用户
  createTime|Date|注册时间
  updateTime|Date|更新时间
  lastLoginTime|Date|最后一次登录时间
  lastLoginAddress|String|最后一次登录地址
**响应消息样例:**
```
{
"msg": "用户登录系统成功!",
"code": 1,
"data": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJsb2dpbl91c2VyX2tleSI6ImRlYjA5YzY1MDM2YzQyMjdiZWVlNTMyMzZhZGViZjVjIn0.KD6I9KumxKVPKVORfCP1yCubLlfOCGDrn7Rv_3rKmbk",
"customer": {
"admin": false,
"contactTelphone": "13888888888",
"createTime": 1655112384000,
"createUserId": 1,
"custName": "测试",
"deleted": 0,
"enterpriseConsultant": "张三",
"expireTime": 1655797369869,
"id": 1,
"job": "总监",
"lastLoginAddress": "0:0:0:0:0:0:0:1",
"loginName": "test",
"loginTime": 1655710969869,
"mailbox": "qqq@123.com",
"manager": false,
"memberLevel": 0,
"organization": "测试公司",
"password": "43442676c74ae59f219c2d87fd6bad52",
"realName": "测试",
"siteCode": "",
"status": 0,
"systemUser": false,
"updateTime": 1655112384000,
"userType": 99
}
}
}
```
### 我的设计
**请求URL:** customer/work/design/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询客户作品信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
**请求样例:**
```
{
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|主键ID，主键，自增长
  customerId|Long|客户ID
  createTime|Date|创建时间
  workDesignName|String|作品名称
  workDesignStatus|Integer|作品状态：0:草稿，1:发布
  workDesignDesc|String|作品描述
  updateTime|Date|更新时间
  pictureIds|String|模版引用的图片
  pictureSrcIds|String|模版引用的素材
  pictureBackgroundIds|String|模版引用的背景
  fontIds|String|作品引用的字体
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 保存更新客户设计作品信息
**请求URL:** customer/work/design/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新客户作品信息：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
customerId|Long|是|客户ID
workDesignName|String|是|作品名称
workDesignStatus|Integer|是|作品状态：0:草稿，1:发布
workDesignDesc|String|是|作品描述
pictureIds|String|是|模版引用的图片
pictureSrcIds|String|是|模版引用的素材
pictureBackgroundIds|String|是|模版引用的背景
fontIds|String|是|作品引用的字体
**请求样例:**
```
{
"customerId":6797,
"workDesignName":"c42lp8",
"workDesignStatus":3570,
"workDesignDesc":"g3odxd",
"pictureIds":"3fd0o6",
"pictureSrcIds":"ykn50w",
"pictureBackgroundIds":"ad0eh7",
"fontIds":"f3bacv"
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|主键ID，主键，自增长
  customerId|Long|客户ID
  createTime|Date|创建时间
  workDesignName|String|作品名称
  workDesignStatus|Integer|作品状态：0:草稿，1:发布
  workDesignDesc|String|作品描述
  updateTime|Date|更新时间
  pictureIds|String|模版引用的图片
  pictureSrcIds|String|模版引用的素材
  pictureBackgroundIds|String|模版引用的背景
  fontIds|String|作品引用的字体
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除客户设计作品信息
**请求URL:** customer/work/design/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除客户作品信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/customer/work/design/delete?id=1,2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
### 我的收藏
**请求URL:** customer/work/collect/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询客户收藏信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
**请求样例:**
```
{
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|主键ID，主键，自增长
  customerId|Long|客户ID
  masterplateId|Long|模版ID
  createTime|Date|收藏时间
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
### 新增客户收藏信息
**请求URL:** customer/work/collect/save
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 保存或更新客户收藏信息：id为空时为新增保存，否则为更新提交
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:-------
masterplateId|Long|是|模版ID
**请求样例:**
```
{
"masterplateId":1002,
}
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|保存后主键id
 entity|object|保存更新实体
  id|Long|主键ID，主键，自增长
  customerId|Long|客户ID
  masterplateId|Long|模版ID
  createTime|Date|收藏时间
**响应消息样例:**
```
{
"msg":"新增模块成功",
"code":1,
"data":{}
}
}
```
### 删除客户收藏信息
**请求URL:** customer/work/collect/delete
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 删除客户收藏信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|String|是|数组
**请求样例:**
```
http://localhost:8080/customer/work/collect/delete?id=1,2'
```
**响应参数:**
参数名称 |参数类型|备注|其它
---|---|---|---
code|Integer|结果码（-1.失败，1.成功）|-
msg|String|消息|-
**响应消息样例:**
```
{
"code":1,
"msg":"成功"
}
```
### 个人信息
**请求URL:** customer/info
**请求方式:** GET
**内容类型:** application/json;charset=utf-8
**简要描述:** 查看客户管理，返回实例详细信息
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
id|Long|是|ID
**请求样例:**
```
http://localhost/customer/info?id=549
```
**响应参数:**
参数名称 |参数类型|描述
:---|:---|:-------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 id|Long|主键ID，主键，自增长
 loginName|String|用户登录账号
 password|String|密码
 memberLevel|Integer|会员等级，，0：未开启，1：试用客户，2：VIP，3：设计师，默认0
 custName|String|客户真实名称
 organization|String|单位名称
 contactTelphone|String|联系电话
 enterpriseConsultant|String|企业顾问
 siteId|Long|站点ID
 sex|Integer|性别
 mailbox|String|邮箱
 job|String|职位
 customerSrc|Long|客户来源
 status|Integer|使用状态，1:正常，0:禁用，默认：0
 createUserId|Long|创建用户
 createTime|Date|注册时间
 updateTime|Date|更新时间
 lastLoginTime|Date|最后一次登录时间
 lastLoginAddress|String|最后一次登录地址
dict|object|字典对象
**响应消息样例:**
```
{
"code": 1,
"data": {
"id":1891,
"loginName":"j86901",
"password":"lj8ggh",
"memberLevel":3360,
"custName":"0w46i4",
"organization":"s7m48f",
"contactTelphone":"pk6oif",
"enterpriseConsultant":"9nq9cu",
"siteId":8898,
"sex":6793,
"mailbox":"sfl4qi",
"job":"obaa5n",
"customerSrc":4745,
"status":1713,
"createUserId":5749,
"createTime":"2022-06-15",
"updateTime":"2022-06-15",
"lastLoginTime":"2022-06-15",
"lastLoginAddress":"kvpqto"
}
}
```
### 模板中心
**请求URL:** design/masterplate/list
**请求方式:** POST
**内容类型:** application/json;charset=utf-8
**简要描述:** 查询模版管理
**请求参数:**
参数名称|类型|必填|描述
:---|:---|:---|:------
masterplateName|String|否|模板名称
page|Integer|否|当前页
size|Integer|否|每页条数，值为-1，查询所有记录
**请求样例:**
```
{
"masterplateName":"test",
"page":1,
"size":10
}
```
**响应参数:**
参数名称|参数类型|描述
:---|:---|:------
code|Integer|结果码（-1.失败，1.成功）
msg|String|消息
data|object|数据对象
 per_page|Integer|每页条数
 total|Integer|总条数
 last_page|Integer|总页数
 current_page|Integer|当前页
 data|array|结果集列表|数组
  id|Long|主键ID，主键，自增长
  masterplateName|Long|模版名称
  masterplateCode|Integer|模版编码
  customerId|Long|发布人
  customerName|String|发布人名称
  createTime|Date|发布时间
  masterplateDesc|String|模版描述
  masterplatePath|String|模版下载地址（相对地址）
  pictureId|Long|模版引用的图片
  pictureSrcId|Long|模版引用的素材
  pictureBackgroundId|Long|模版引用的背景
  fontId|Long|模版引用的字体
  masterplateUseNum|Integer|模版被引用的次数。默认：0
dict|object|字典对象
**响应消息样例:**
```
{
"code":1,
"data":{
}
}
```
\ No newline at end of file
eas-manager/src/main/java/com/mortals/xhx/module/customer/web/CustomerController.java
View file @ e2217e79
package com.mortals.xhx.module.customer.web;
import com.alibaba.fastjson.JSONObject;
import com.mortals.framework.annotation.UnAuth;
import com.mortals.framework.common.IBaseEnum;
import com.mortals.framework.exception.AppException;
import com.mortals.framework.model.Context;
......@@ -152,4 +153,5 @@ public class CustomerController extends BaseCRUDJsonBodyMappingController<Custom
entity.setPassword(null);
return 1;
}
}
\ No newline at end of file
Markdown is supported
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