📡 API 参考

完整的后端接口文档 | 50+ 核心 API | 实时更新

🔐 认证服务 ⚙️ 设备管理 🔋 订单服务 📊 运营大盘 💳 结算服务 📱 小程序 🚪 服务端口

🚪 微服务端口

API 网关
8080
所有API请求入口
管理服务
8081
登录、用户、权限管理
业务服务
8082
设备、订单、计费、结算
小程序服务
8083
小程序用户、站点、充电服务
定时任务
8084
定时任务、数据清理、报表
代理模块
8085
代理商管理和结算

🔐 认证与授权

管理员登录
POST /auth/admin/login

账号密码方式登录,返回 JWT Token

参数 类型 描述
username String 用户名
password String 密码(MD5加密)
{ "username": "admin", "password": "123456" }
短信验证码登录
POST /auth/admin/sms-login

短信验证码方式登录

参数 类型 描述
phone String 手机号
smsCode String 短信验证码
💡 演示模式: 验证码 = 手机号后4位(如 13800138000 的验证码是 8000)
发送短信验证码
POST /auth/admin/send-sms

发送短信验证码

参数 类型 描述
phone String 目标手机号

⚙️ 设备管理

区域管理
GET /device/region - 获取区域列表
POST /device/region - 新建区域
PUT /device/region/{id} - 编辑区域
DELETE /device/region/{id} - 删除区域

支持树形结构,支持多级区域

站点管理
GET /device/site - 获取站点列表
GET /device/site/nearby - 获取附近站点
POST /device/site - 新建站点
PUT /device/site/{id} - 编辑站点

支持地理位置查询,支持收藏功能

充电桩管理
GET /device/station - 获取充电桩列表
POST /device/station - 新建充电桩
PUT /device/station/{id}/status - 更新状态

支持状态管理、数据同步

充电枪管理
GET /device/gun - 获取充电枪列表
PUT /device/gun/{id}/data - 更新实时数据
POST /device/gun/{id}/stop - 停止充电

支持实时数据更新、远程停止

🔋 订单服务

开始充电
POST /charge/start

创建充电订单,开始计费

参数 类型 描述
gunId Long 充电枪ID
userId Long 用户ID
paymentMethod String 支付方式
停止充电
POST /charge/stop

停止充电,结束计费,返回费用

参数 类型 描述
orderId Long 订单ID
订单列表
GET /charge/orders

查询订单列表,支持状态筛选和分页

参数 类型 描述
status String 订单状态(charging/completed/failed)
pageNo Integer 页码
pageSize Integer 每页数量

📊 运营大盘

运营统计数据
GET /dashboard/stats

返回总充电笔数、总充电度数、总收益、在线设备数等统计数据

营收趋势
GET /dashboard/revenue-trend

返回最近30天的营收趋势数据,用于图表展示

站点收益排行
GET /dashboard/site-ranking

返回TOP10收益最高的站点排行

实时告警
GET /dashboard/alarm-list

返回设备离线、充电异常等告警信息

设备状态分布
GET /dashboard/device-status

返回设备在线、离线、故障等状态分布

💳 结算分账

分账配置
GET /settlement/share-config - 查询配置
POST /settlement/share-config - 新建配置
PUT /settlement/share-config/{id} - 编辑配置

支持启用/禁用分账配置

结算单
GET /settlement/bill - 查询结算单
POST /settlement/bill/{id}/confirm - 确认结算
POST /settlement/bill/{id}/pay - 打款

支持结算单的查询、确认、打款操作

对账核销
POST /settlement/reconcile/execute - 执行对账

执行银行对账,返回对账结果

📱 小程序服务

用户登录
POST /mini/user/wechat-login

微信授权登录

参数 类型 描述
code String 微信授权code
首页数据
GET /mini/site/home

返回首页站点列表和用户信息

附近站点
GET /mini/site/nearby

基于用户位置查询附近站点

参数 类型 描述
lat Double 纬度
lng Double 经度
distance Integer 查询距离(米)
开始充电
POST /mini/charge/start

小程序开始充电

参数 类型 描述
gunId Long 充电枪ID
订单列表
GET /mini/order/list

查询用户订单列表

参数 类型 描述
status String 订单状态(可选)
pageNo Integer 页码

📦 通用响应格式

成功响应
{ "code": 0, "message": "success", "data": { // 业务数据 } }
错误响应
{ "code": 400, "message": "错误信息描述", "data": null }

常见错误码

错误码 描述
0 成功
400 请求参数错误
401 未授权(Token过期或无效)
403 禁止访问(无权限)
404 资源不存在
500 服务器内部错误

💡 使用说明

📌 认证方式

所有API(除了登录接口外)都需要在请求头中携带 JWT Token:

Authorization: Bearer {token}
🎯 完整的API文档

详细的API参数、返回值、错误处理等完整文档会在源代码的 Javadoc 注释中, 也可以使用 Swagger 在线文档查看:
http://localhost:8080/swagger-ui.html

📝 开发建议
  • 使用 Postman 或 Insomnia 等工具调试API
  • 保存 Bearer Token,在后续请求中使用
  • 注意 API 的请求方法(GET/POST/PUT/DELETE)
  • 检查响应的 HTTP 状态码和业务错误码
  • 完整的源代码API文档可在项目源码中查看