nanxun/ql_apimanager_backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

API定义文档

Browse Source
This commit is contained in:
西街长安 2024-10-24 13:13:52 +00:00
parent 61bc34f276
commit d5d619c18f
1 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
APIDefine.md
View File

@ -1,37 +1,37 @@
## API路径及方法定义
| 模块 | 接口名称 | 路径 | 方法 | 描述 |
| -------- | ------------ | ------------------------------------------------------------ | ------ | ---------------- |
| 用户 | 登录 | /api/user/login | POST | 用户登录 |
| | 注册 | /api/user/register | POST | 用户注册 |
| | 登出 | /api/user/logout | POST | 用户登出 |
| | 重置密码 | /api/user/resetpassword | POST | 找回密码 |
| | 用户信息 | /api/user/info/{id} | GET | 获取用户信息 |
| | 修改用户信息 | /api/user/update | POST | 修改用户信息 |
| | 用户充值 | /api/user/recharge | POST | 用户充值 |
| | 充值记录 | /api/user/rechargelog?userid={id}&starttime={time}&endtime={time}&type={type}&page={index}&pagesize={size}&desc={true\|false} | GET | 充值记录查询 |
| | 添加用户 | /api/admin/adduser | POST | 管理员添加用户 |
| | 删除用户 | /api/admin/deleteuser/{id} | DELETE | 管理员删除用户 |
| | 添加余额 | /api/admin/updatebalace | POST | 管理员修改余额 |
| | 禁用用户 | /api/admin/ban/{id} | POST | 禁用用户 |
| | 用户列表 | /api/admin/userlist?page={index}&pagesize={size}&desc={true\|false} | GET | 查询用户列表 |
| API | 添加接口 | /api/admin/addapi | POST | 添加API |
| | 删除接口 | /api/admin/deleteapi/{id} | DELETE | 删除API |
| | 禁用接口 | /api/admin/banapi/{id} | POST | 禁用API |
| | 修改接口 | /api/admin/updateapi?id={id} | POST | 修改接口信息 |
| | 接口信息 | /api/apiinfo/{id} | GET | 获取API信息 |
| | 接口列表 | /api/admin/apilist?page={index}&pagesize={size}&desc={true\|false} | GET | 查询接口列表 |
| | 接口调用查询 | /api/apilog?userid={id}&starttime={time}&endtime={time}&method={method}&page={index}&apiid={id}&userid={id}&pagesize={size}&desc={true\|false} | GET | 查询接口调用 |
| 套餐 | 添加套餐 | /api/admin/addpackage | POST | 添加套餐 |
| | 修改套餐 | /api/admin/updatepackage?id={id} | POST | 修改套餐信息 |
| | 删除套餐 | /api/admin/deletepackage/{id} | DELETE | 删除套餐 |
| | 套餐列表 | /api/admin/packagelist?page={index}&pagesize={size} | GET | 套餐列表 |
| | 购买套餐 | /api/user/buypackage/?packageid={id} | POST | 购买套餐 |
| 支付 | 支付记录查询 | /api/payment/log?payid={id}&userid={id}&starttime={time}&endtime={time}&method={method}&page={index}&pagesize={size}&desc={true\|false} | GET | 支付记录查询 |
| | 订单查询 | /api/payment/orderlog?page={index}&pagesize={size}&starttime={time}&endtime={time}&status={status} | GET | 订单查询 |
| | 取消订单 | /api/user/cancelorder/{id} | DELETE | 取消订单 |
| 用户套餐 | 添加用户套餐 | /api/admin/userpackageadd | POST | 添加用户关联套餐 |
| | 删除用户套餐 | /api/admin/userpackagedelete/{id} | DELETE | 删除用户关联套餐 |
| | 用户套餐查询 | /api/admin/userpackagelist/{id} | GET | 用户关联套餐查询 |
| 系统配置 | 配置修改 | /api/admin/updateconfig | POST | 系统配置修改 |
| 模块 | 接口名称 | 路径 | 方法 | 描述 |
| -------- | ---------------- | ------------------------------------------------------------ | ------ | ---------------- |
| 用户 | 登录 | /api/user/login | POST | 用户登录 |
| | 注册 | /api/user/register | POST | 用户注册 |
| | 登出 | /api/user/logout | POST | 用户登出 |
| | 重置密码 | /api/user/resetpassword | POST | 找回密码 |
| | 用户信息 | /api/user/info/{id} | GET | 获取用户信息 |
| | 修改用户信息 | /api/user/update | POST | 修改用户信息 |
| | 用户充值 | /api/user/recharge | POST | 用户充值 |
| | 添加用户 | /api/admin/adduser | POST | 管理员添加用户 |
| | 删除用户 | /api/admin/deleteuser/{id} | DELETE | 管理员删除用户 |
| | 添加余额 | /api/admin/updatebalace | POST | 管理员修改余额 |
| | 禁用用户 | /api/admin/ban/{id} | POST | 禁用用户 |
| | 用户列表 | /api/admin/userlist?page={index}&pagesize={size}&desc={true\|false} | GET | 查询用户列表 |
| API | 添加接口 | /api/admin/addapi | POST | 添加API |
| | 删除接口 | /api/admin/deleteapi/{id} | DELETE | 删除API |
| | 禁用接口 | /api/admin/banapi/{id} | POST | 禁用API |
| | 修改接口 | /api/admin/updateapi?id={id} | POST | 修改接口信息 |
| | 接口信息 | /api/apiinfo/{id} | GET | 获取API信息 |
| | 接口列表 | /api/admin/apilist?page={index}&pagesize={size}&desc={true\|false} | GET | 查询接口列表 |
| | 接口调用查询 | /api/apilog?userid={id}&starttime={time}&endtime={time}&method={method}&page={index}&apiid={id}&userid={id}&pagesize={size}&desc={true\|false} | GET | 查询接口调用 |
| 套餐 | 添加套餐 | /api/admin/addpackage | POST | 添加套餐 |
| | 修改套餐 | /api/admin/updatepackage?id={id} | POST | 修改套餐信息 |
| | 删除套餐 | /api/admin/deletepackage/{id} | DELETE | 删除套餐 |
| | 套餐列表 | /api/admin/packagelist?page={index}&pagesize={size} | GET | 套餐列表 |
| | 购买套餐 | /api/user/buypackage/?packageid={id} | POST | 购买套餐 |
| 订单 | 支付记录查询 | /api/payment/loglist?payid={id}&userid={id}&starttime={time}&endtime={time}&method={method}&page={index}&pagesize={size}&desc={true\|false} | GET | 支付记录查询 |
| | 订单信息查询 | /api/payment/orderlog/{id} | POST | 订单查询 |
| | 取消订单 | /api/payment/cancelorder/{id} | DELETE | 取消订单 |
| 用户套餐 | 添加用户套餐 | /api/admin/userpackageadd | POST | 添加用户关联套餐 |
| | 修改用户套餐时间 | /api/admin/userpackageupdate/id={id}&expire={time} | DELETE | 删除用户关联套餐 |
| | 用户套餐查询 | /api/admin/userpackagelist/{id} | GET | 用户已购套餐查询 |
| 系统配置 | 配置修改 | /api/admin/updateconfig | POST | 系统配置修改 |
| 操作日志 | 操作日志列表 | /api/operation/log?userid={id}&page={index}&pagesize={size}&starttime={time}&endtime={time}&desc={true\|false} | GET | 操作日志查询 |