调用手册

这里集中说明「所有接口共用」的规则。接口页不再重复这些内容,只给最终路径。

1. 完整 URL 怎么拼

https://dscp-dev.hn12301.net + /manage-api + /sms/addSmsCardLog
渠道(@Route)URL 前缀dev 主机 + 前缀接口数
管理后台 MANAGE_API/manage-apihttps://dscp-dev.hn12301.net/manage-api1237
小程序 MP_API/mp-apihttps://dscp-dev.hn12301.net/mp-api64
H5 H5_API/h5-apihttps://dscp-dev.hn12301.net/h5-api44
App APP_API/app-apihttps://dscp-dev.hn12301.net/app-api33
质惠游 ZHY_API/zhy-apihttps://dscp-dev.hn12301.net/zhy-api25
核销端 CHECKER_API/checker-apihttps://dscp-dev.hn12301.net/checker-api0
开放/回调 OPEN_API/open-apihttps://dscp-dev.hn12301.net/open-api347
生产主机未确认。 旧版在 1405 张卡片里各写了一遍 pro 行,且值指向 uat 主机(示意)。v2 不再逐接口重复: 需要生产地址请向运维确认,确认后写入 tools/build.py 的 HOSTS 重新生成即可,只改一处。

2. 响应外层包装(chaos 框架统一)

字段类型说明
errcodeint业务码,0 = 成功
errmsgstring提示信息
dataT各接口「响应 · data」列出的结构

前端同时兼容 {code, msg, data};activity_h5 按其 request 封装记为 {code, message, data}。 接口页只写 data 结构,不再重复外层包装。

3. 鉴权与请求头

前端目录名技术栈认证与约定
管理后台dscp-html-manageVue3 + Vite + Element Plus + axiosbaseURL=/manage-api; auth=Authorization: Bearer + tenant-id
湘工惠商城xghmalluni-app + uView (Vue2)prefix=/app-api,/mp-api
爱上萍乡 小程序pingxiangcarduni-app + Vue3 + TS + Piniaprefix=/mp-api
质惠游 公众号 H5h5-meikeuni-app + uView (Vue2)prefix=open-api,h5-api
怀化人社 H5hhrsuni-app + uView (Vue2)prefix=h5-api
景区核销writeoffuni-app + uView (Vue2)prefix=checker-api
怀化社保卡活动 H5activity_h5uni-app + Vue3prefix=h5-api

管理后台:Authorization: Bearer <token>,多租户时另带 tenant-id;code==200 或 errcode==0 判成功,401 / errcode 30002 触发重登。 各端 baseURL 与渠道前缀详见 前端页。

4. 错误码

机器可读导出:运行 python3 tools/to_openapi.py 生成 ../data/openapi.json(OpenAPI 3.0,1661 条路径), 可导入 Apifox / Postman 或生成 mock;渠道、数据表、调用点等证据放在 x-channels / x-tables / x-callers 扩展字段。

错误码就在源码常量类里:ResCode.java(业务码)与 chaos ChaosRes.java(框架码), 形如 public static final ResBean CARD_NUMBER_ERROR = new ResBean(20001, "卡号不存在或状态错误")。 完整对照、每个码被多少个接口抛出,见 错误码字典;接口卡片也会列出该接口可能抛出的业务码。

唯一未覆盖的来源:管理后台的 system_error_code 表(前端页面 dscp-html-manage/src/views/system/errorCode),用于运行时自定义提示语,与源码常量不保证一致。 需要 DBA 导出该表并入 data/ 后才能真正对齐。

5. 「未发现调用」到底是什么意思

本次只扫描 7 个前端仓库源码里的请求路径字面量(含 url:、post('/x')、xxxUrl = '...' 三种写法)。 服务端内部调用、定时任务、其它未纳入仓库的端、动态拼接的路径不在扫描范围内。 因此「未发现调用」≠「可以下线」,只能作为排查线索。

6. 已知扫描局限

由 tools/build.py 从 data/apis.json 生成 · 生成时间 2026-09-12 19:49 · 数据口径见说明 · 本页数字非手写,均来自同一份数据