跳转至

API 参考

适用基线：测试环境目标 / dev 分支 / 2026-07-15。 阅读对象：测试、实施、运维（主）；集成开发（顺带）。

业务目的与适用范围

联调卡在「路径找不到、鉴权失败、业务页说有动作但 Swagger 对不上」时，先来本组：讲清如何发现接口、如何按约定调用、失败时联查哪里。业务「为什么有这个动作」仍以各业务模块页为准；平台调用轨迹与重试见数据交换与集成可靠性。

读完本页，应能：按「约定 → 模块索引 → 场景矩阵 → 业务页相关接口」顺序定位；并知道本站不提供全量 OpenAPI 抄本——完整字段以环境 Knife4j/Swagger 为准。

本轮 不 把全站 Controller 逐条抄成手册（体量过大且易过期）。此处沉淀已证实的组织方式、抽样路径与挂接矩阵。

如何使用本组文档

你的目的 建议阅读
第一次调管理端 API 调用约定与文档发现
按模块找代表性路径 模块接口索引
看跨系统谁推谁、权威在哪 跨系统集成场景
单据级动作与业务影响 对应业务页「相关接口」表
调用失败 / 异步重试 数据交换

建议阅读顺序

顺序 页面 用途
1 调用约定与文档发现 协议、认证、权限、在线文档入口。
2 模块接口索引 按模块找业务能力与代表性路径。
3 跨系统集成场景 ERP/SCP/WMS/MES/QMS 等挂接方向。
4 业务页「相关接口」表 单据级动作与影响。

写实示例：发现一条接口

给定： 要确认「拉取当前用户权限信息」路径。 做法： 打开调用约定页确认认证边界 → 在模块索引「System」节找到 GET /system/auth/get-permission-info → 到环境 Knife4j 核字段 → 业务含义回 租户与认证。不要在本站臆造 Header 名或网关前缀的唯一真值。

写作边界

内容 写在哪里
业务规则、状态机、库存影响 各业务模块页
调用路径、认证、幂等线索、集成方向 本 API 参考
调用成败、异步重试、访问/错误日志 数据交换、日志
技术 DO/DTO/源码路径 仅 project-docs 证据页

当前齐套状态

项 状态
调用约定与文档发现 已发布
模块接口索引（抽样） 已发布
跨系统集成场景 已发布
全量字段级 OpenAPI 导出 未做；用 Knife4j + 业务页续补
PS 模块接口 无实现，见PS 资料缺口

建议验证点

  • 能在目标环境打开对应服务的 Knife4j/Swagger（可能按服务分别入口）。
  • 能从模块索引落到一条抽样路径，并在 Swagger 核到同名方法。
  • 权限失败时能联查 RBAC / 权限标识，而不是只看前端按钮。

相关材料