# YAPI 接口文档

- Admin管理员 密码操作
  - 密码加密
  - 破解密码
- Redis测试操作
  - 删除
  - 新增
  - 查询
- 企业微信消息推送
  - gitlab钩子
  - 消息推送
- 图片操作
  - 合并图片返回文件
- 微信开放平台 -- 消息
  - 接受微信推送过来的消息

# crmeb_java_public

crmeb_java_public

# Admin管理员 密码操作

## 密码加密

### 基本信息

Path： /api/public/auth/test/account/encode

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 否 |  | 账号
password | 否 |  | 密码

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 破解密码

### 基本信息

Path： /api/public/auth/test/account/decode

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
account | 否 |  | 账号
encodeString | 否 |  | 加密字符串

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# Redis测试操作

## 删除

### 基本信息

Path： /api/public/test/redis/delete

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
key | 否 |  | redis key

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 新增

### 基本信息

Path： /api/public/test/redis/set

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
key | 否 |  | redis key
value | 否 |  | 内容

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 查询

### 基本信息

Path： /api/public/test/redis/get

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
key | 否 |  | redis key

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 企业微信消息推送

## gitlab钩子

### 基本信息

Path： /api/public/wechat/gitlab

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
token | 否 |  | 企业微信群token

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

## 消息推送

### 基本信息

Path： /api/public/wechat/push

Method： GET

接口描述：

### 请求参数

Query

参数名称 | 是否必须 | 示例 | 备注
--- | --- | --- | ---
message | 否 |  | 推送消息内容
token | 否 |  | 企业微信群token

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 图片操作

## 合并图片返回文件

### 基本信息

Path： /api/public/qrcode/mergeList

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

Body

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| object [] | 非必须 |  |  | item 类型: object
├─ path | string | 必须 |  | 图片地址 |
├─ x | integer | 必须 |  | x轴 | format: int32
├─ y | integer | 必须 |  | y轴 | format: int32

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
code | integer | 非必须 |  |  | format: int64
data | object | 非必须 |  |  |
message | string | 非必须 |  |  |

# 微信开放平台 -- 消息

## 接受微信推送过来的消息

### 基本信息

Path： /api/public/wechat/message/webHook

Method： POST

接口描述：

### 请求参数

Headers

参数名称 | 参数值 | 是否必须 | 示例 | 备注
--- | --- | --- | --- | ---
Content-Type | application/json | 是 |  |

### 返回数据

名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息
--- | --- | --- | --- | --- | ---
| string | 非必须 |  |  |