You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

319 lines
16 KiB

3 months ago
  1. <h1 class="curproject-name"> crmeb_java_public </h1>
  2. crmeb_java_public
  3. # Admin管理员 密码操作
  4. ## 密码加密
  5. <a id=密码加密> </a>
  6. ### 基本信息
  7. **Path:** /api/public/auth/test/account/encode
  8. **Method:** POST
  9. **接口描述:**
  10. ### 请求参数
  11. **Headers**
  12. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  13. | ------------ | ------------ | ------------ | ------------ | ------------ |
  14. | Content-Type | application/json | 是 | | |
  15. **Query**
  16. | 参数名称 | 是否必须 | 示例 | 备注 |
  17. | ------------ | ------------ | ------------ | ------------ |
  18. | account | 否 | | 账号 |
  19. | password | 否 | | 密码 |
  20. ### 返回数据
  21. <table>
  22. <thead class="ant-table-thead">
  23. <tr>
  24. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  25. </tr>
  26. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  27. </tbody>
  28. </table>
  29. ## 破解密码
  30. <a id=破解密码> </a>
  31. ### 基本信息
  32. **Path:** /api/public/auth/test/account/decode
  33. **Method:** POST
  34. **接口描述:**
  35. ### 请求参数
  36. **Headers**
  37. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  38. | ------------ | ------------ | ------------ | ------------ | ------------ |
  39. | Content-Type | application/json | 是 | | |
  40. **Query**
  41. | 参数名称 | 是否必须 | 示例 | 备注 |
  42. | ------------ | ------------ | ------------ | ------------ |
  43. | account | 否 | | 账号 |
  44. | encodeString | 否 | | 加密字符串 |
  45. ### 返回数据
  46. <table>
  47. <thead class="ant-table-thead">
  48. <tr>
  49. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  50. </tr>
  51. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  52. </tbody>
  53. </table>
  54. # Redis测试操作
  55. ## 删除
  56. <a id=删除> </a>
  57. ### 基本信息
  58. **Path:** /api/public/test/redis/delete
  59. **Method:** GET
  60. **接口描述:**
  61. ### 请求参数
  62. **Query**
  63. | 参数名称 | 是否必须 | 示例 | 备注 |
  64. | ------------ | ------------ | ------------ | ------------ |
  65. | key | 否 | | redis key |
  66. ### 返回数据
  67. <table>
  68. <thead class="ant-table-thead">
  69. <tr>
  70. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  71. </tr>
  72. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  73. </tbody>
  74. </table>
  75. ## 新增
  76. <a id=新增> </a>
  77. ### 基本信息
  78. **Path:** /api/public/test/redis/set
  79. **Method:** POST
  80. **接口描述:**
  81. ### 请求参数
  82. **Headers**
  83. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  84. | ------------ | ------------ | ------------ | ------------ | ------------ |
  85. | Content-Type | application/json | 是 | | |
  86. **Query**
  87. | 参数名称 | 是否必须 | 示例 | 备注 |
  88. | ------------ | ------------ | ------------ | ------------ |
  89. | key | 否 | | redis key |
  90. | value | 否 | | 内容 |
  91. ### 返回数据
  92. <table>
  93. <thead class="ant-table-thead">
  94. <tr>
  95. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  96. </tr>
  97. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  98. </tbody>
  99. </table>
  100. ## 查询
  101. <a id=查询> </a>
  102. ### 基本信息
  103. **Path:** /api/public/test/redis/get
  104. **Method:** GET
  105. **接口描述:**
  106. ### 请求参数
  107. **Query**
  108. | 参数名称 | 是否必须 | 示例 | 备注 |
  109. | ------------ | ------------ | ------------ | ------------ |
  110. | key | 否 | | redis key |
  111. ### 返回数据
  112. <table>
  113. <thead class="ant-table-thead">
  114. <tr>
  115. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  116. </tr>
  117. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  118. </tbody>
  119. </table>
  120. # 企业微信消息推送
  121. ## gitlab钩子
  122. <a id=gitlab钩子> </a>
  123. ### 基本信息
  124. **Path:** /api/public/wechat/gitlab
  125. **Method:** POST
  126. **接口描述:**
  127. ### 请求参数
  128. **Headers**
  129. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  130. | ------------ | ------------ | ------------ | ------------ | ------------ |
  131. | Content-Type | application/json | 是 | | |
  132. **Query**
  133. | 参数名称 | 是否必须 | 示例 | 备注 |
  134. | ------------ | ------------ | ------------ | ------------ |
  135. | token | 否 | | 企业微信群token |
  136. **Body**
  137. <table>
  138. <thead class="ant-table-thead">
  139. <tr>
  140. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  141. </tr>
  142. </thead><tbody className="ant-table-tbody"><tr key=0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> </span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  143. </tbody>
  144. </table>
  145. ### 返回数据
  146. <table>
  147. <thead class="ant-table-thead">
  148. <tr>
  149. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  150. </tr>
  151. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  152. </tbody>
  153. </table>
  154. ## 消息推送
  155. <a id=消息推送> </a>
  156. ### 基本信息
  157. **Path:** /api/public/wechat/push
  158. **Method:** GET
  159. **接口描述:**
  160. ### 请求参数
  161. **Query**
  162. | 参数名称 | 是否必须 | 示例 | 备注 |
  163. | ------------ | ------------ | ------------ | ------------ |
  164. | message | 否 | | 推送消息内容 |
  165. | token | 否 | | 企业微信群token |
  166. ### 返回数据
  167. <table>
  168. <thead class="ant-table-thead">
  169. <tr>
  170. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  171. </tr>
  172. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  173. </tbody>
  174. </table>
  175. # 图片操作
  176. ## 合并图片返回文件
  177. <a id=合并图片返回文件> </a>
  178. ### 基本信息
  179. **Path:** /api/public/qrcode/mergeList
  180. **Method:** POST
  181. **接口描述:**
  182. ### 请求参数
  183. **Headers**
  184. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  185. | ------------ | ------------ | ------------ | ------------ | ------------ |
  186. | Content-Type | application/json | 是 | | |
  187. **Body**
  188. <table>
  189. <thead class="ant-table-thead">
  190. <tr>
  191. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  192. </tr>
  193. </thead><tbody className="ant-table-tbody"><tr key=0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> </span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> path</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">图片地址</span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> x</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">x轴</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> y</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">y轴</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
  194. </tbody>
  195. </table>
  196. ### 返回数据
  197. <table>
  198. <thead class="ant-table-thead">
  199. <tr>
  200. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  201. </tr>
  202. </thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> message</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  203. </tbody>
  204. </table>
  205. # 微信开放平台 -- 消息
  206. ## 接受微信推送过来的消息
  207. <a id=接受微信推送过来的消息> </a>
  208. ### 基本信息
  209. **Path:** /api/public/wechat/message/webHook
  210. **Method:** POST
  211. **接口描述:**
  212. ### 请求参数
  213. **Headers**
  214. | 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
  215. | ------------ | ------------ | ------------ | ------------ | ------------ |
  216. | Content-Type | application/json | 是 | | |
  217. ### 返回数据
  218. <table>
  219. <thead class="ant-table-thead">
  220. <tr>
  221. <th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
  222. </tr>
  223. </thead><tbody className="ant-table-tbody"><tr key=0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> </span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
  224. </tbody>
  225. </table>