mirror of
https://gitee.com/ZhongBangKeJi/crmeb_java.git
synced 2026-04-23 03:58:35 +08:00
新增接口文档包
This commit is contained in:
张乐
853
接口文档/公共接口/public_api.html
Normal file
853
接口文档/公共接口/public_api.html
Normal file
@@ -0,0 +1,853 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>crmeb_java_public</title>
|
||||
<meta charset="utf-8" />
|
||||
<style>@charset "UTF-8";
|
||||
html,
|
||||
body,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
p,
|
||||
blockquote {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-weight: normal;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
}
|
||||
|
||||
/* 设置滚动条的样式 */
|
||||
::-webkit-scrollbar {
|
||||
width: 6px;
|
||||
}
|
||||
|
||||
/* 外层轨道 */
|
||||
::-webkit-scrollbar-track {
|
||||
-webkit-box-shadow: inset006pxrgba(255, 0, 0, 0.3);
|
||||
background: rgba(0, 0, 0, 0.1);
|
||||
}
|
||||
|
||||
/* 滚动条滑块 */
|
||||
::-webkit-scrollbar-thumb {
|
||||
border-radius: 4px;
|
||||
background: rgba(0, 0, 0, 0.2);
|
||||
-webkit-box-shadow: inset006pxrgba(0, 0, 0, 0.5);
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-thumb:window-inactive {
|
||||
background: rgba(0, 0, 0, 0.2);
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Helvetica, "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei", SimSun, sans-serif;
|
||||
font-size: 13px;
|
||||
line-height: 25px;
|
||||
color: #393838;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
table {
|
||||
margin: 10px 0 15px 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
td,
|
||||
th {
|
||||
border: 1px solid #ddd;
|
||||
padding: 3px 10px;
|
||||
}
|
||||
|
||||
th {
|
||||
padding: 5px 10px;
|
||||
}
|
||||
|
||||
a, a:link, a:visited {
|
||||
color: #34495e;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover, a:focus {
|
||||
color: #59d69d;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a img {
|
||||
border: none;
|
||||
}
|
||||
|
||||
p {
|
||||
padding-left: 10px;
|
||||
margin-bottom: 9px;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
color: #404040;
|
||||
line-height: 36px;
|
||||
}
|
||||
|
||||
h1 {
|
||||
color: #2c3e50;
|
||||
font-weight: 600;
|
||||
margin-bottom: 16px;
|
||||
font-size: 32px;
|
||||
padding-bottom: 16px;
|
||||
border-bottom: 1px solid #ddd;
|
||||
line-height: 50px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 28px;
|
||||
padding-top: 10px;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
h3 {
|
||||
clear: both;
|
||||
font-weight: 400;
|
||||
margin-top: 20px;
|
||||
margin-bottom: 20px;
|
||||
border-left: 3px solid #59d69d;
|
||||
padding-left: 8px;
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
h5 {
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
hr {
|
||||
margin: 0 0 19px;
|
||||
border: 0;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
padding: 13px 13px 21px 15px;
|
||||
margin-bottom: 18px;
|
||||
font-family: georgia, serif;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
blockquote:before {
|
||||
font-size: 40px;
|
||||
margin-left: -10px;
|
||||
font-family: georgia, serif;
|
||||
color: #eee;
|
||||
}
|
||||
|
||||
blockquote p {
|
||||
font-size: 14px;
|
||||
font-weight: 300;
|
||||
line-height: 18px;
|
||||
margin-bottom: 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
code,
|
||||
pre {
|
||||
font-family: Monaco, Andale Mono, Courier New, monospace;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: #fee9cc;
|
||||
color: rgba(0, 0, 0, 0.75);
|
||||
padding: 1px 3px;
|
||||
font-size: 12px;
|
||||
-webkit-border-radius: 3px;
|
||||
-moz-border-radius: 3px;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
pre {
|
||||
display: block;
|
||||
padding: 14px;
|
||||
margin: 0 0 18px;
|
||||
line-height: 16px;
|
||||
font-size: 11px;
|
||||
border: 1px solid #d9d9d9;
|
||||
white-space: pre-wrap;
|
||||
word-wrap: break-word;
|
||||
background: #f6f6f6;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background-color: #f6f6f6;
|
||||
color: #737373;
|
||||
font-size: 11px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
sup {
|
||||
font-size: 0.83em;
|
||||
vertical-align: super;
|
||||
line-height: 0;
|
||||
}
|
||||
|
||||
* {
|
||||
-webkit-print-color-adjust: exact;
|
||||
}
|
||||
|
||||
@media print {
|
||||
body,
|
||||
code,
|
||||
pre code,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
color: black;
|
||||
}
|
||||
|
||||
table,
|
||||
pre {
|
||||
page-break-inside: avoid;
|
||||
}
|
||||
}
|
||||
html,
|
||||
body {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
.table-of-contents {
|
||||
position: fixed;
|
||||
top: 61px;
|
||||
left: 0;
|
||||
bottom: 0;
|
||||
overflow-x: hidden;
|
||||
overflow-y: auto;
|
||||
width: 260px;
|
||||
}
|
||||
|
||||
.table-of-contents > ul > li > a {
|
||||
font-size: 20px;
|
||||
margin-bottom: 16px;
|
||||
margin-top: 16px;
|
||||
}
|
||||
|
||||
.table-of-contents ul {
|
||||
overflow: auto;
|
||||
margin: 0px;
|
||||
height: 100%;
|
||||
padding: 0px 0px;
|
||||
box-sizing: border-box;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
.table-of-contents ul li {
|
||||
padding-left: 20px;
|
||||
}
|
||||
|
||||
.table-of-contents a {
|
||||
padding: 2px 0px;
|
||||
display: block;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.content-right {
|
||||
max-width: 700px;
|
||||
margin-left: 290px;
|
||||
padding-left: 70px;
|
||||
flex-grow: 1;
|
||||
}
|
||||
.content-right h2:target {
|
||||
padding-top: 80px;
|
||||
}
|
||||
|
||||
body > p {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
body > table {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
body > pre {
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
.curProject {
|
||||
position: fixed;
|
||||
top: 20px;
|
||||
font-size: 25px;
|
||||
color: black;
|
||||
margin-left: -240px;
|
||||
width: 240px;
|
||||
padding: 5px;
|
||||
line-height: 25px;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
.g-doc {
|
||||
margin-top: 56px;
|
||||
padding-top: 24px;
|
||||
display: flex;
|
||||
}
|
||||
|
||||
.curproject-name {
|
||||
font-size: 42px;
|
||||
}
|
||||
|
||||
.m-header {
|
||||
background: #32363a;
|
||||
height: 56px;
|
||||
line-height: 56px;
|
||||
padding-left: 60px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
position: fixed;
|
||||
z-index: 9;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
}
|
||||
.m-header .title {
|
||||
font-size: 22px;
|
||||
color: #fff;
|
||||
font-weight: normal;
|
||||
-webkit-font-smoothing: antialiased;
|
||||
margin: 0;
|
||||
margin-left: 16px;
|
||||
padding: 0;
|
||||
line-height: 56px;
|
||||
border: none;
|
||||
}
|
||||
.m-header .nav {
|
||||
color: #fff;
|
||||
font-size: 16px;
|
||||
position: absolute;
|
||||
right: 32px;
|
||||
top: 0;
|
||||
}
|
||||
.m-header .nav a {
|
||||
color: #fff;
|
||||
margin-left: 16px;
|
||||
padding: 8px;
|
||||
transition: color .2s;
|
||||
}
|
||||
.m-header .nav a:hover {
|
||||
color: #59d69d;
|
||||
}
|
||||
|
||||
.m-footer {
|
||||
border-top: 1px solid #ddd;
|
||||
padding-top: 16px;
|
||||
padding-bottom: 16px;
|
||||
}
|
||||
|
||||
/*# sourceMappingURL=defaultTheme.css.map */
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="m-header">
|
||||
<a href="#" style="display: inherit;"><svg class="svg" width="32px" height="32px" viewBox="0 0 64 64" version="1.1"><title>Icon</title><desc>Created with Sketch.</desc><defs><linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1"><stop stop-color="#FFFFFF" offset="0%"></stop><stop stop-color="#F2F2F2" offset="100%"></stop></linearGradient><circle id="path-2" cx="31.9988602" cy="31.9988602" r="2.92886048"></circle><filter x="-85.4%" y="-68.3%" width="270.7%" height="270.7%" filterUnits="objectBoundingBox" id="filter-3"><feOffset dx="0" dy="1" in="SourceAlpha" result="shadowOffsetOuter1"></feOffset><feGaussianBlur stdDeviation="1.5" in="shadowOffsetOuter1" result="shadowBlurOuter1"></feGaussianBlur><feColorMatrix values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.159703351 0" type="matrix" in="shadowBlurOuter1"></feColorMatrix></filter></defs><g id="首页" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="大屏幕"><g id="Icon"><circle id="Oval-1" fill="url(#linearGradient-1)" cx="32" cy="32" r="32"></circle><path d="M36.7078009,31.8054514 L36.7078009,51.7110548 C36.7078009,54.2844537 34.6258634,56.3695395 32.0579205,56.3695395 C29.4899777,56.3695395 27.4099998,54.0704461 27.4099998,51.7941246 L27.4099998,31.8061972 C27.4099998,29.528395 29.4909575,27.218453 32.0589004,27.230043 C34.6268432,27.241633 36.7078009,29.528395 36.7078009,31.8054514 Z" id="blue" fill="#2359F1" fill-rule="nonzero"></path><path d="M45.2586091,17.1026914 C45.2586091,17.1026914 45.5657231,34.0524383 45.2345291,37.01141 C44.9033351,39.9703817 43.1767091,41.6667796 40.6088126,41.6667796 C38.040916,41.6667796 35.9609757,39.3676862 35.9609757,37.0913646 L35.9609757,17.1034372 C35.9609757,14.825635 38.0418959,12.515693 40.6097924,12.527283 C43.177689,12.538873 45.2586091,14.825635 45.2586091,17.1026914 Z" id="green" fill="#57CF27" fill-rule="nonzero" transform="translate(40.674608, 27.097010) rotate(60.000000) translate(-40.674608, -27.097010) "></path><path d="M28.0410158,17.0465598 L28.0410158,36.9521632 C28.0410158,39.525562 25.9591158,41.6106479 23.3912193,41.6106479 C20.8233227,41.6106479 18.7433824,39.3115545 18.7433824,37.035233 L18.7433824,17.0473055 C18.7433824,14.7695034 20.8243026,12.4595614 23.3921991,12.4711513 C25.9600956,12.4827413 28.0410158,14.7695034 28.0410158,17.0465598 Z" id="red" fill="#FF561B" fill-rule="nonzero" transform="translate(23.392199, 27.040878) rotate(-60.000000) translate(-23.392199, -27.040878) "></path><g id="inner-round"><use fill="black" fill-opacity="1" filter="url(#filter-3)" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#path-2"></use><use fill="#F7F7F7" fill-rule="evenodd" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#path-2"></use></g></g></g></g></svg></a>
|
||||
<a href="#"><h1 class="title">YAPI 接口文档</h1></a>
|
||||
<div class="nav">
|
||||
<a href="https://yapi.ymfe.org/">YApi</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="g-doc">
|
||||
<div class="table-of-contents"><ul><li><a href="#adminu7ba1u7406u545820u5bc6u7801u64cdu4f5c">Admin管理员 密码操作</a><ul><li><a href="#u5bc6u7801u52a0u5bc60a3ca20id3du5bc6u7801u52a0u5bc63e203ca3e">密码加密
|
||||
<a id=密码加密> </a></a></li><li><a href="#u7834u89e3u5bc6u78010a3ca20id3du7834u89e3u5bc6u78013e203ca3e">破解密码
|
||||
<a id=破解密码> </a></a></li></ul></li><li><a href="#redisu6d4bu8bd5u64cdu4f5c">Redis测试操作</a><ul><li><a href="#u5220u96640a3ca20id3du5220u96643e203ca3e">删除
|
||||
<a id=删除> </a></a></li><li><a href="#u65b0u589e0a3ca20id3du65b0u589e3e203ca3e">新增
|
||||
<a id=新增> </a></a></li><li><a href="#u67e5u8be20a3ca20id3du67e5u8be23e203ca3e">查询
|
||||
<a id=查询> </a></a></li></ul></li><li><a href="#u4f01u4e1au5faeu4fe1u6d88u606fu63a8u9001">企业微信消息推送</a><ul><li><a href="#gitlabu94a9u5b500a3ca20id3dgitlabu94a9u5b503e203ca3e">gitlab钩子
|
||||
<a id=gitlab钩子> </a></a></li><li><a href="#u6d88u606fu63a8u90010a3ca20id3du6d88u606fu63a8u90013e203ca3e">消息推送
|
||||
<a id=消息推送> </a></a></li></ul></li><li><a href="#u56feu7247u64cdu4f5c">图片操作</a><ul><li><a href="#u5408u5e76u56feu7247u8fd4u56deu6587u4ef60a3ca20id3du5408u5e76u56feu7247u8fd4u56deu6587u4ef63e203ca3e">合并图片返回文件
|
||||
<a id=合并图片返回文件> </a></a></li></ul></li><li><a href="#u5faeu4fe1u5f00u653eu5e73u53f020-20u6d88u606f">微信开放平台 -- 消息</a><ul><li><a href="#u63a5u53d7u5faeu4fe1u63a8u9001u8fc7u6765u7684u6d88u606f0a3ca20id3du63a5u53d7u5faeu4fe1u63a8u9001u8fc7u6765u7684u6d88u606f3e203ca3e">接受微信推送过来的消息
|
||||
<a id=接受微信推送过来的消息> </a></a></li></ul></li></ul></div>
|
||||
<div id="right" class="content-right">
|
||||
<h1 class="curproject-name"> crmeb_java_public </h1>
|
||||
crmeb_java_public
|
||||
<h1 id="adminu7ba1u7406u545820u5bc6u7801u64cdu4f5c">Admin管理员 密码操作</h1>
|
||||
<p></p>
|
||||
<h2 id="u5bc6u7801u52a0u5bc60a3ca20id3du5bc6u7801u52a0u5bc63e203ca3e">密码加密
|
||||
<a id=密码加密> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/auth/test/account/encode</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-2">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>account</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>账号</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>密码</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-3">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="u7834u89e3u5bc6u78010a3ca20id3du7834u89e3u5bc6u78013e203ca3e">破解密码
|
||||
<a id=破解密码> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-4">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/auth/test/account/decode</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-5">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>account</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>账号</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>encodeString</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>加密字符串</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-6">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1 id="redisu6d4bu8bd5u64cdu4f5c">Redis测试操作</h1>
|
||||
<p></p>
|
||||
<h2 id="u5220u96640a3ca20id3du5220u96643e203ca3e">删除
|
||||
<a id=删除> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-7">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/test/redis/delete</p>
|
||||
<p><strong>Method：</strong> GET</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-8">请求参数</h3>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>key</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>redis key</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-9">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="u65b0u589e0a3ca20id3du65b0u589e3e203ca3e">新增
|
||||
<a id=新增> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-10">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/test/redis/set</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-11">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>key</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>redis key</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>value</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>内容</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-12">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="u67e5u8be20a3ca20id3du67e5u8be23e203ca3e">查询
|
||||
<a id=查询> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-13">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/test/redis/get</p>
|
||||
<p><strong>Method：</strong> GET</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-14">请求参数</h3>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>key</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>redis key</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-15">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1 id="u4f01u4e1au5faeu4fe1u6d88u606fu63a8u9001">企业微信消息推送</h1>
|
||||
<p></p>
|
||||
<h2 id="gitlabu94a9u5b500a3ca20id3dgitlabu94a9u5b503e203ca3e">gitlab钩子
|
||||
<a id=gitlab钩子> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-16">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/wechat/gitlab</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-17">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>token</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>企业微信群token</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Body</strong></p>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-18">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="u6d88u606fu63a8u90010a3ca20id3du6d88u606fu63a8u90013e203ca3e">消息推送
|
||||
<a id=消息推送> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-19">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/wechat/push</p>
|
||||
<p><strong>Method：</strong> GET</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-20">请求参数</h3>
|
||||
<p><strong>Query</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>message</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>推送消息内容</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>token</td>
|
||||
<td>否</td>
|
||||
<td></td>
|
||||
<td>企业微信群token</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-21">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1 id="u56feu7247u64cdu4f5c">图片操作</h1>
|
||||
<p></p>
|
||||
<h2 id="u5408u5e76u56feu7247u8fd4u56deu6587u4ef60a3ca20id3du5408u5e76u56feu7247u8fd4u56deu6587u4ef63e203ca3e">合并图片返回文件
|
||||
<a id=合并图片返回文件> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-22">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/qrcode/mergeList</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-23">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><strong>Body</strong></p>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-24">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1 id="u5faeu4fe1u5f00u653eu5e73u53f020-20u6d88u606f">微信开放平台 -- 消息</h1>
|
||||
<p></p>
|
||||
<h2 id="u63a5u53d7u5faeu4fe1u63a8u9001u8fc7u6765u7684u6d88u606f0a3ca20id3du63a5u53d7u5faeu4fe1u63a8u9001u8fc7u6765u7684u6d88u606f3e203ca3e">接受微信推送过来的消息
|
||||
<a id=接受微信推送过来的消息> </a></h2>
|
||||
<p></p>
|
||||
<h3 id="-25">基本信息</h3>
|
||||
<p><strong>Path：</strong> /api/public/wechat/message/webHook</p>
|
||||
<p><strong>Method：</strong> POST</p>
|
||||
<p><strong>接口描述：</strong></p>
|
||||
<h3 id="-26">请求参数</h3>
|
||||
<p><strong>Headers</strong></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>参数名称</th>
|
||||
<th>参数值</th>
|
||||
<th>是否必须</th>
|
||||
<th>示例</th>
|
||||
<th>备注</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Content-Type</td>
|
||||
<td>application/json</td>
|
||||
<td>是</td>
|
||||
<td></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="-27">返回数据</h3>
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<footer class="m-footer">
|
||||
<p>Build by <a href="https://ymfe.org/">YMFE</a>.</p>
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
443
接口文档/公共接口/public_api.json
Normal file
443
接口文档/公共接口/public_api.json
Normal file
@@ -0,0 +1,443 @@
|
||||
[
|
||||
{
|
||||
"index": 0,
|
||||
"name": "Admin管理员 密码操作",
|
||||
"desc": "Authorization Admin",
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"list": [
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/auth/test/account/encode",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7178,
|
||||
"method": "POST",
|
||||
"title": "密码加密",
|
||||
"path": "/api/public/auth/test/account/encode",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab7bc7e8e560914fbe9",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab7bc7e8e560914fbeb",
|
||||
"name": "account",
|
||||
"desc": "账号"
|
||||
},
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab7bc7e8e560914fbea",
|
||||
"name": "password",
|
||||
"desc": "密码"
|
||||
}
|
||||
],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«Map»\",\n \"$$ref\": \"#/definitions/CommonResult«Map»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4838,
|
||||
"uid": 93,
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"__v": 0
|
||||
},
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/auth/test/account/decode",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7176,
|
||||
"method": "POST",
|
||||
"title": "破解密码",
|
||||
"path": "/api/public/auth/test/account/decode",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab7bc7e8e560914fbe6",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab7bc7e8e560914fbe8",
|
||||
"name": "account",
|
||||
"desc": "账号"
|
||||
},
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab7bc7e8e560914fbe7",
|
||||
"name": "encodeString",
|
||||
"desc": "加密字符串"
|
||||
}
|
||||
],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«Map»\",\n \"$$ref\": \"#/definitions/CommonResult«Map»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4838,
|
||||
"uid": 93,
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"__v": 0
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"index": 0,
|
||||
"name": "Redis测试操作",
|
||||
"desc": "Redis Test Controller",
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"list": [
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/test/redis/delete",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": false,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7182,
|
||||
"method": "GET",
|
||||
"title": "删除",
|
||||
"path": "/api/public/test/redis/delete",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbed",
|
||||
"name": "key",
|
||||
"desc": "redis key"
|
||||
}
|
||||
],
|
||||
"req_body_type": "raw",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«object»\",\n \"$$ref\": \"#/definitions/CommonResult«object»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4847,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
},
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/test/redis/set",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7186,
|
||||
"method": "POST",
|
||||
"title": "新增",
|
||||
"path": "/api/public/test/redis/set",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab8bc7e8e560914fbef",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbf1",
|
||||
"name": "key",
|
||||
"desc": "redis key"
|
||||
},
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbf0",
|
||||
"name": "value",
|
||||
"desc": "内容"
|
||||
}
|
||||
],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«object»\",\n \"$$ref\": \"#/definitions/CommonResult«object»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4847,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
},
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/test/redis/get",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": false,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7184,
|
||||
"method": "GET",
|
||||
"title": "查询",
|
||||
"path": "/api/public/test/redis/get",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbee",
|
||||
"name": "key",
|
||||
"desc": "redis key"
|
||||
}
|
||||
],
|
||||
"req_body_type": "raw",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«object»\",\n \"$$ref\": \"#/definitions/CommonResult«object»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4847,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"index": 0,
|
||||
"name": "企业微信消息推送",
|
||||
"desc": "We Chat Push Controller",
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"list": [
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/wechat/gitlab",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7188,
|
||||
"method": "POST",
|
||||
"title": "gitlab钩子",
|
||||
"path": "/api/public/wechat/gitlab",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab8bc7e8e560914fbf2",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbf3",
|
||||
"name": "token",
|
||||
"desc": "企业微信群token"
|
||||
}
|
||||
],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«object»\",\n \"$$ref\": \"#/definitions/CommonResult«object»\"\n}",
|
||||
"req_body_other": "{\n \"type\": \"string\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4856,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
},
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/wechat/push",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": false,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7192,
|
||||
"method": "GET",
|
||||
"title": "消息推送",
|
||||
"path": "/api/public/wechat/push",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [],
|
||||
"req_query": [
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbf6",
|
||||
"name": "message",
|
||||
"desc": "推送消息内容"
|
||||
},
|
||||
{
|
||||
"required": "0",
|
||||
"_id": "5f35eab8bc7e8e560914fbf5",
|
||||
"name": "token",
|
||||
"desc": "企业微信群token"
|
||||
}
|
||||
],
|
||||
"req_body_type": "raw",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\"\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«object»\",\n \"$$ref\": \"#/definitions/CommonResult«object»\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4856,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"index": 0,
|
||||
"name": "图片操作",
|
||||
"desc": "Image Merge Controller",
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"list": [
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/qrcode/mergeList",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7180,
|
||||
"method": "POST",
|
||||
"title": "合并图片返回文件",
|
||||
"path": "/api/public/qrcode/mergeList",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab7bc7e8e560914fbec",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"object\",\n \"properties\": {\n \"code\": {\n \"type\": \"integer\",\n \"format\": \"int64\"\n },\n \"data\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n },\n \"message\": {\n \"type\": \"string\"\n }\n },\n \"title\": \"CommonResult«Map«string,string»»\",\n \"$$ref\": \"#/definitions/CommonResult«Map«string,string»»\"\n}",
|
||||
"req_body_other": "{\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"required\": [\n \"path\",\n \"x\",\n \"y\"\n ],\n \"properties\": {\n \"path\": {\n \"type\": \"string\",\n \"description\": \"图片地址\"\n },\n \"x\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"description\": \"x轴\"\n },\n \"y\": {\n \"type\": \"integer\",\n \"format\": \"int32\",\n \"description\": \"y轴\"\n }\n },\n \"title\": \"ImageMergeUtilVo\",\n \"$$ref\": \"#/definitions/ImageMergeUtilVo\"\n }\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4865,
|
||||
"uid": 93,
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"__v": 0
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"index": 0,
|
||||
"name": "微信开放平台 -- 消息",
|
||||
"desc": "We Chat Message Controller",
|
||||
"add_time": 1597369015,
|
||||
"up_time": 1597369015,
|
||||
"list": [
|
||||
{
|
||||
"query_path": {
|
||||
"path": "/api/public/wechat/message/webHook",
|
||||
"params": []
|
||||
},
|
||||
"edit_uid": 0,
|
||||
"status": "undone",
|
||||
"type": "static",
|
||||
"req_body_is_json_schema": true,
|
||||
"res_body_is_json_schema": true,
|
||||
"api_opened": false,
|
||||
"index": 0,
|
||||
"tag": [],
|
||||
"_id": 7190,
|
||||
"method": "POST",
|
||||
"title": "接受微信推送过来的消息",
|
||||
"path": "/api/public/wechat/message/webHook",
|
||||
"req_params": [],
|
||||
"req_body_form": [],
|
||||
"req_headers": [
|
||||
{
|
||||
"required": "1",
|
||||
"_id": "5f35eab8bc7e8e560914fbf4",
|
||||
"name": "Content-Type",
|
||||
"value": "application/json"
|
||||
}
|
||||
],
|
||||
"req_query": [],
|
||||
"req_body_type": "json",
|
||||
"res_body_type": "json",
|
||||
"res_body": "{\n \"type\": \"string\"\n}",
|
||||
"project_id": 55,
|
||||
"catid": 4874,
|
||||
"uid": 93,
|
||||
"add_time": 1597369016,
|
||||
"up_time": 1597369016,
|
||||
"__v": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
320
接口文档/公共接口/public_api.md
Normal file
320
接口文档/公共接口/public_api.md
Normal file
@@ -0,0 +1,320 @@
|
||||
|
||||
<h1 class="curproject-name"> crmeb_java_public </h1>
|
||||
crmeb_java_public
|
||||
|
||||
|
||||
# Admin管理员 密码操作
|
||||
|
||||
## 密码加密
|
||||
<a id=密码加密> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/auth/test/account/encode
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| account | 否 | | 账号 |
|
||||
| password | 否 | | 密码 |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 破解密码
|
||||
<a id=破解密码> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/auth/test/account/decode
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| account | 否 | | 账号 |
|
||||
| encodeString | 否 | | 加密字符串 |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
# Redis测试操作
|
||||
|
||||
## 删除
|
||||
<a id=删除> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/test/redis/delete
|
||||
|
||||
**Method：** GET
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| key | 否 | | redis key |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 新增
|
||||
<a id=新增> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/test/redis/set
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| key | 否 | | redis key |
|
||||
| value | 否 | | 内容 |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 查询
|
||||
<a id=查询> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/test/redis/get
|
||||
|
||||
**Method：** GET
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| key | 否 | | redis key |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
# 企业微信消息推送
|
||||
|
||||
## gitlab钩子
|
||||
<a id=gitlab钩子> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/wechat/gitlab
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| token | 否 | | 企业微信群token |
|
||||
**Body**
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 消息推送
|
||||
<a id=消息推送> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/wechat/push
|
||||
|
||||
**Method：** GET
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Query**
|
||||
|
||||
| 参数名称 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ |
|
||||
| message | 否 | | 推送消息内容 |
|
||||
| token | 否 | | 企业微信群token |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
# 图片操作
|
||||
|
||||
## 合并图片返回文件
|
||||
<a id=合并图片返回文件> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/qrcode/mergeList
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
**Body**
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
# 微信开放平台 -- 消息
|
||||
|
||||
## 接受微信推送过来的消息
|
||||
<a id=接受微信推送过来的消息> </a>
|
||||
### 基本信息
|
||||
|
||||
**Path：** /api/public/wechat/message/webHook
|
||||
|
||||
**Method：** POST
|
||||
|
||||
**接口描述：**
|
||||
|
||||
|
||||
### 请求参数
|
||||
**Headers**
|
||||
|
||||
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|
||||
| ------------ | ------------ | ------------ | ------------ | ------------ |
|
||||
| Content-Type | application/json | 是 | | |
|
||||
|
||||
### 返回数据
|
||||
|
||||
<table>
|
||||
<thead class="ant-table-thead">
|
||||
<tr>
|
||||
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
||||
</tr>
|
||||
</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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
483
接口文档/公共接口/public_swaggerApi.json
Normal file
483
接口文档/公共接口/public_swaggerApi.json
Normal file
@@ -0,0 +1,483 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"title": "crmeb_java_public",
|
||||
"version": "last",
|
||||
"description": "crmeb_java_public"
|
||||
},
|
||||
"basePath": "/",
|
||||
"tags": [
|
||||
{
|
||||
"name": "Admin管理员 密码操作",
|
||||
"description": "Authorization Admin"
|
||||
},
|
||||
{
|
||||
"name": "Redis测试操作",
|
||||
"description": "Redis Test Controller"
|
||||
},
|
||||
{
|
||||
"name": "企业微信消息推送",
|
||||
"description": "We Chat Push Controller"
|
||||
},
|
||||
{
|
||||
"name": "图片操作",
|
||||
"description": "Image Merge Controller"
|
||||
},
|
||||
{
|
||||
"name": "微信开放平台 -- 消息",
|
||||
"description": "We Chat Message Controller"
|
||||
}
|
||||
],
|
||||
"schemes": [
|
||||
"http"
|
||||
],
|
||||
"paths": {
|
||||
"/api/public/auth/test/account/encode": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Admin管理员 密码操作"
|
||||
],
|
||||
"summary": "密码加密",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "account",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "账号",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "password",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "密码",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«Map»",
|
||||
"$$ref": "#/definitions/CommonResult«Map»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/auth/test/account/decode": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Admin管理员 密码操作"
|
||||
],
|
||||
"summary": "破解密码",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "account",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "账号",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "encodeString",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "加密字符串",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«Map»",
|
||||
"$$ref": "#/definitions/CommonResult«Map»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/test/redis/delete": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Redis测试操作"
|
||||
],
|
||||
"summary": "删除",
|
||||
"consumes": [
|
||||
"text/plain"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "redis key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "raw",
|
||||
"in": "body",
|
||||
"description": "raw paramter",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«object»",
|
||||
"$$ref": "#/definitions/CommonResult«object»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/test/redis/set": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"Redis测试操作"
|
||||
],
|
||||
"summary": "新增",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "redis key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "value",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "内容",
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«object»",
|
||||
"$$ref": "#/definitions/CommonResult«object»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/test/redis/get": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"Redis测试操作"
|
||||
],
|
||||
"summary": "查询",
|
||||
"consumes": [
|
||||
"text/plain"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "key",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "redis key",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "raw",
|
||||
"in": "body",
|
||||
"description": "raw paramter",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«object»",
|
||||
"$$ref": "#/definitions/CommonResult«object»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/wechat/gitlab": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"企业微信消息推送"
|
||||
],
|
||||
"summary": "gitlab钩子",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "token",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "企业微信群token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "root",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«object»",
|
||||
"$$ref": "#/definitions/CommonResult«object»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/wechat/push": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"企业微信消息推送"
|
||||
],
|
||||
"summary": "消息推送",
|
||||
"consumes": [
|
||||
"text/plain"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "message",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "推送消息内容",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "token",
|
||||
"in": "query",
|
||||
"required": false,
|
||||
"description": "企业微信群token",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"name": "raw",
|
||||
"in": "body",
|
||||
"description": "raw paramter",
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "binary"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«object»",
|
||||
"$$ref": "#/definitions/CommonResult«object»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/qrcode/mergeList": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"图片操作"
|
||||
],
|
||||
"summary": "合并图片返回文件",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"name": "root",
|
||||
"in": "body",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"path",
|
||||
"x",
|
||||
"y"
|
||||
],
|
||||
"properties": {
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "图片地址"
|
||||
},
|
||||
"x": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "x轴"
|
||||
},
|
||||
"y": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "y轴"
|
||||
}
|
||||
},
|
||||
"title": "ImageMergeUtilVo",
|
||||
"$$ref": "#/definitions/ImageMergeUtilVo"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"data": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"title": "CommonResult«Map«string,string»»",
|
||||
"$$ref": "#/definitions/CommonResult«Map«string,string»»"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/public/wechat/message/webHook": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"微信开放平台 -- 消息"
|
||||
],
|
||||
"summary": "接受微信推送过来的消息",
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"parameters": [],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user