This commit is contained in:
2025-03-26 11:55:10 +08:00
parent 3e7295fec4
commit 2fada5b9ac
7 changed files with 307 additions and 264 deletions

View File

@@ -10,31 +10,109 @@
.txt-lf{text-align: left}
</style>
<div style="width: 50%;margin: 0 auto;color: red;text-align: center;">
<div class="txt-lf">文档说明:</div>
<div class="txt-lf">1、如果没有明确说明提交请求均使用post</div>
<div class="txt-lf">2、此接口文档不包含websocket接口</div>
<div class="txt-lf">3、接口参数之间使用“/”符号隔开</div>
<div class="txt-lf">4、此文档接口测试功能只针对普通post、get接口不能测试文件上传或文件流</div>
<div class="txt-lf">5、功能模块按照颜色分组</div>
<div class="txt-lf">文档说明:</div>
<div class="txt-lf">1、如果没有明确说明提交请求均使用post</div>
<div class="txt-lf">2、此接口文档不包含websocket接口</div>
<div class="txt-lf">3、接口参数之间使用“/”符号隔开</div>
<div class="txt-lf">4、此文档接口测试功能只针对普通post、get接口不能测试文件上传或文件流</div>
<div class="txt-lf">5、功能模块按照颜色分组</div>
<div class="txt-lf" style="color: black;">清理缓存:
<a href='JavaScript:;' onclick="CacheObj.clearCache()">
点击清理
</a><span style="color: gray;font-size: 12px;">(由于接口数据可能会被缓存,发现数据没变化或需要时,可清理缓存)</span>
</div>
<div class="txt-lf">
<a href="/api_docs/api_list.html" style="margin: 20px">api应用文档</a>
<a href="/api_docs/api_list.html" style="margin: 20px">api应用文档</a>
</div>
</div>
<div id="api_workers_getWorkers" style="background-color: #ffe4e1;margin-top: 50px;">
<div class="markdown_content">
***
```
/**
* desc获取工作人员列表
*
请求地址:
* api/Workers/getWorkers
*
* 参数:
* mobile 手机号码
* rel_wxid 关联微信
* firm_id 所属企业
*
* 所有字段说明<span style="color: gray">(可能有部分额外字段未在此体现)</span>
* id ID
* username 用户名
* nickname 昵称
* password 密码
* salt 密码盐
* avatar 头像
* email 电子邮箱
* mobile 手机号码
* loginfailure 失败次数
* logintime 登录时间
* loginip 登录IP
* createtime 创建时间
* updatetime 更新时间
* token Session标识
* role 角色:admin=管理员,firm=企业人员
* status 状态
* rel_wxid 关联微信
* employee_type 类型:1=企业微信,2=个人微信
* firm_id 所属企业
* firmstore_id 所属店铺
* firmduty_id 职务
* authorwh
* api/workers/getWorkers
*/
```
</div>
<div>
按需填写其它接口参数:
<textarea name="" id="api_workers_getWorkers_textarea" cols="100" rows="3">/api/workers/getWorkers</textarea>
<a href='JavaScript:;' onclick="DocObject.api_workers_getWorkers()">测试</a>
</div>
<div class="api_workers_getWorkers_response_result"></div>
</div>
</div>
</body>
<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
<script src="/static/common/js/marked.min.js"></script>
<script src="/webautocodestatic/marked.min.js"></script>
<script src="/webautocodestatic/plugs/layui-v2.9.2/layui.js"></script>
<script>
$(function() {
//加载markdown
DocObject.markdown_content();
});
let CacheObj = {
clearCache: function () {
let url = '/index/test/clearCache';
$.post(url,{},function(res) {
layer.msg('清理成功')
},'json');
}
};
let DocObject = {
markdown_content(){
$('.markdown_content').each(function(k,ele) {
$(ele).html(marked.parse($(ele).html()));
});
},
api_workers_getWorkers(){
let url = $('#api_workers_getWorkers_textarea').val();
$.post(url,{},function(res) {
$('.api_workers_getWorkers_response_result').html(JSON.stringify(res, null, "\t"));
$('.api_workers_getWorkers_response_result').attr('style','color:green');
},'json');
},
}
</script>

View File

@@ -3,3 +3,44 @@
###### ctrl+f 搜索)(如果更改了路由,请根据路由规则定位)
##### 请求域名http://127.0.0.1:8080/
##### 请求方式POST默认
***
```
/**
* desc获取工作人员列表
*
请求地址:
* api/Workers/getWorkers
*
* 参数:
* mobile 手机号码
* rel_wxid 关联微信
* firm_id 所属企业
*
* 所有字段说明<span style="color: gray">(可能有部分额外字段未在此体现)</span>
* id ID
* username 用户名
* nickname 昵称
* password 密码
* salt 密码盐
* avatar 头像
* email 电子邮箱
* mobile 手机号码
* loginfailure 失败次数
* logintime 登录时间
* loginip 登录IP
* createtime 创建时间
* updatetime 更新时间
* token Session标识
* role 角色:admin=管理员,firm=企业人员
* status 状态
* rel_wxid 关联微信
* employee_type 类型:1=企业微信,2=个人微信
* firm_id 所属企业
* firmstore_id 所属店铺
* firmduty_id 职务
* authorwh
* api/workers/getWorkers
*/
```