Files
hfb_sys/docs/api.md
T

1.9 KiB

API 规划

API 规划以 项目计划 第 10 章为准。

一期接口按模块推进:

  • 认证:短信验证码、手机号登录、Token 刷新、退出登录。
  • 实名:发起认证、查询状态、服务回调。
  • 发布:创建、修改、提交审核、下架、列表、详情。
  • 订单:创建、取消、确认收号、提交归还、确认归还、发起申诉。
  • 交接:提交交接说明、查看交接记录。
  • 钱包:余额、流水、提现预留。
  • 通知:站内信列表、标记已读。
  • 后台:审核、订单、仲裁、资金流水、系统配置、审计日志。

已实现接口

  • POST /api/auth/sms/send
  • POST /api/auth/sms/login
  • POST /api/auth/refresh
  • POST /api/auth/logout
  • GET /api/me
  • POST /api/realname/start
  • GET /api/realname/status
  • GET /api/listings
  • GET /api/listings/{id}
  • POST /api/listings
  • PUT /api/listings/{id}
  • POST /api/listings/{id}/submit-review
  • DELETE /api/listings/{id}
  • GET /api/seller/listings
  • GET /api/seller/listings/{id}
  • POST /api/orders
  • GET /api/orders
  • GET /api/orders/{id}
  • POST /api/orders/{id}/cancel
  • POST /api/orders/{id}/handoff
  • GET /api/orders/{id}/handoff-records
  • POST /api/orders/{id}/confirm-receive
  • POST /api/orders/{id}/return
  • POST /api/orders/{id}/confirm-return
  • POST /api/orders/{id}/dispute
  • GET /api/disputes
  • GET /api/disputes/{id}
  • GET /api/wallet/balance
  • GET /api/wallet/ledger
  • GET /api/notifications
  • POST /api/notifications/{id}/read
  • POST /api/admin/auth/login
  • POST /api/admin/auth/logout
  • GET /api/admin/me
  • GET /api/admin/disputes
  • POST /api/admin/disputes/{id}/arbitrate
  • GET /api/admin/system-configs
  • PUT /api/admin/system-configs/{key}

说明:/api/admin/* 当前是开发态 mock 后台接口,只要求登录,后续接入后台管理员账号、RBAC 和 Casbin 权限后再收紧访问控制。