zhongyouweb/docs/api

API 接口资料中心

本目录由项目上级目录的 api.json 生成，用于开发时快速定位接口、用途和字段。不要直接手工修改 modules/、schemas.md 和 catalog.json；源文件更新后重新运行生成脚本。

文档概况

• OpenAPI：3.0.3
• 文档标题：标题：管理系统_接口文档
• 文档版本：版本号:3.8.7
• 服务地址：http://www.bjsdqc.cn:10090
• 鉴权定义：X-Access-Token（apiKey，header: X-Access-Token）
• 接口数量：278
• 数据模型：32

开发时怎么查

1. 先打开 页面接口映射，按页面找到需要的接口和主要字段。
2. 再进入下方对应业务模块，查看完整请求参数、请求体和响应模型。
3. 需要跨模块全文检索时，在本目录搜索接口中文名、字段名或 URL 片段。
4. 程序化检索使用 catalog.json，数据模型统一查看 schemas.md。

业务模块

模块	接口数	文档
common-controller	2	打开
test-controller-1	5	打开
隐患信息管理	21	打开
隐患上报流程	6	打开
隐患流程模板配置	6	打开
用户积分账户	15	打开
积分流水明细	14	打开
积分规则配置	14	打开
积分申诉管理	21	打开
积分兑换订单管理	14	打开
兑换物品管理	14	打开
兑换订单追踪	14	打开
兑换安全配置	16	打开
兑换操作日志	14	打开
防刷分管控配置	18	打开
商城端接口对接	4	打开
数据分析	17	打开
操作审计日志	13	打开
流程定义	11	打开
工作流流程任务管理	23	打开
工作流流程实例管理	4	打开
工作流流程_公用信息	1	打开
工作流流程_签字审批	2	打开
流程审批_签字	1	打开
用户消息中心	5	打开
消息处理接口	1	打开
系统工具	2	打开

更新文档

在 zhongyou_web 目录执行：

npm run docs:api

联调注意事项

• OpenAPI 中的服务器地址和多数路径都含有 /gd_dataserver，部分完整路径出现两次；前端接入时应结合 VUE_APP_BASE_API 与请求代理确认，避免重复拼接。
• 大部分接口声明使用请求头 X-Access-Token。商城对接接口还单独声明了 token 请求头，联调前需向后端确认两者的关系。
• 一些通用 CRUD 接口的响应只声明为 object，页面字段应以具体实体模型和真实响应为准。
• 本文档描述接口能力，不代表当前登录角色一定拥有调用权限。