API市场服务需求文档

1. 文档说明 1.1 文档目标 本文档用于对 API 市场服务的业务能力进行结构化整理，并按功能域拆分模块，为后续原型设计、接口设计、数据库设计、任务排期与项目实施提供统一依据。

1.2 适用范围 适用于 API 市场服务前后端系统建设，覆盖以下角色与业务范围：

API 使用者 API 提供者 审批人员 运营/管理员 1.3 建设目标 建设统一的 API 市场平台，实现 API 的展示、搜索、申请、审批、授权、调用监控、推荐运营、日志追踪与 API 生命周期管理，提升 API 发现效率、接入效率、运营能力与安全管控能力。

2. 业务角色定义 2.1 API 使用者 面向需要检索、申请、调用 API 的用户，核心诉求为快速找到可用 API、完成申请、查看授权状态并安全调用。

2.2 API 提供者 面向创建、发布、维护 API 的用户，核心诉求为便捷配置 API 信息、测试与发布 API、跟踪使用情况。

2.3 审批人员 面向处理 API 使用申请、发布申请等审批工单的人员，核心诉求为高效查看申请信息、执行审批、跟踪审批流。

2.4 平台管理员/运营人员 面向平台整体管理的角色，核心诉求为 API 推荐运营、访问控制、日志追踪、监控分析、审批流程配置等。

3. 总体业务流程 3.1 API 使用主流程 使用者进入 API 市场首页。 通过搜索、分类、推荐、热门、最新等方式发现目标 API。 进入 API 详情页查看接口说明、示例、错误码、流控策略、发布人等信息。 对需要授权的 API 发起使用申请。 审批人员在审批工单中完成审批。 审批通过后，使用者在接口授权中查看授权状态与 token。 使用者调用 API，平台记录调用日志与监控数据。 3.2 API 发布主流程 API 提供者创建 API。 配置基本信息、请求参数、返回参数、错误码、流控规则、测试示例等内容。 提交发布申请。 审批人员完成发布审批。 审批通过后 API 上架展示在 API 市场。 提供者后续可查看详情、下线、撤回或编辑。
4. 功能模块拆分 本系统建议拆分为 8 个一级功能模块。

4.1 API 市场门户模块 面向 API 使用者，承担 API 展示、搜索、分类浏览、推荐展示、详情查看等能力。

4.1.1 API 搜索 功能描述： 支持用户快速检索 API，提升 API 发现效率。

功能要求：

支持按照 API 名称模糊搜索。 支持按照 API 路径模糊搜索。 支持按照 API 描述模糊搜索。 支持展示 API 搜索结果列表。 支持从搜索结果进入 API 使用详情页。 关键输出：

搜索条件 搜索结果列表 API 详情跳转 4.1.2 热门 API 功能描述： 基于模型使用情况或 API 调用次数，展示热门 API 列表。

功能要求：

展示调用次数最多的前几个 API。 每个 API 展示图标、名称、评分、描述、申请次数、调用次数等信息。 点击后进入 API 详情页。 4.1.3 最新 API 功能描述： 展示最新上架 API，帮助用户了解平台最新能力。

功能要求：

展示最新发布的 API。 每个 API 展示图标、名称、描述。 点击后进入 API 详情页。 4.1.4 推荐 API 功能描述： 向用户推荐优质或重点 API。

功能要求：

支持全部 API 推荐。 支持应用 API、数据 API、模型 API、汇聚 API 分类推荐。 推荐 API 以列表或卡片形式展示。 4.1.5 API 分类与排序 功能描述： 支持按分类与多种维度查看 API。

功能要求：

支持 API 分类浏览。 支持按调用次数排序。 支持按申请次数排序。 支持按发布日期排序。 支持按浏览次数排序。 支持按用户评分排序。 4.1.6 API 列表 功能描述： 集中展示平台提供服务的全部 API 目录。

功能要求：

展示所有 API 列表。 支持分页、筛选、排序。 支持查看 API 基本信息、接入方式介绍。 支持进入 API 详情页。 4.1.7 API 详情 功能描述： 展示 API 完整信息，支撑用户评估与接入。

功能要求：

展示应用请求信息。 展示响应示例。 展示错误码。 展示流量控制说明。 展示调用次数、申请次数、浏览次数。 展示发布人、技术负责人、联系方式。 展示创作思路、数据结构、使用方法。 4.1.8 API 示例代码下载 功能描述： 提供示例代码下载，辅助用户完成二次开发。

功能要求：

提供示例代码下载链接。 示例代码应包含 API 调用方式。 示例代码应包含参数设置。 示例代码应包含返回结果处理。 4.2 API 使用申请与我的申请模块 面向 API 使用者，承担使用申请提交、撤回、编辑、状态跟踪等能力。

4.2.1 API 使用申请 功能描述： 对有安全认证要求的 API 发起申请。

功能要求：

用户在 API 市场选择目标 API 后发起申请。 弹出申请信息填写表单。 申请时需选择对应应用。 需填写申请理由。 需填写访问 IP 网段。 需填写流量策略。 提交后在授权列表中可查看申请状态，初始状态为待审批。 4.2.2 我的申请-API 使用申请列表 功能描述： 供申请人统一管理 API 使用申请。

功能要求：

展示使用申请列表。 未通过状态下，审批中支持撤回操作。 已撤回状态下支持编辑操作。 已驳回状态下支持编辑操作。 支持查看申请状态与审批结果。 4.2.3 我的申请-API 发布申请列表 功能描述： 供 API 提供者统一管理 API 发布申请。

功能要求：

展示发布申请列表。 未通过状态下，审批中支持撤回操作。 已撤回状态下支持编辑操作。 已驳回状态下支持编辑操作。 4.3 审批工单与审批管理模块 面向审批人员与管理员，承担审批处理与流程配置能力。

4.3.1 审批工单 功能描述： 处理 API 使用申请与发布申请等审批业务。

功能要求：

发起 API 使用申请后，申请人在“我的申请”中可看到工单。 审批人在审批工单中可查看待处理工单。 审批人员可执行通过或驳回。 驳回时必须填写驳回理由。 审批通过后，申请者可使用对应 API。 审批通过后，在授权 API 中可查看生效中的授权状态。 4.3.2 审批管理-API 使用/发布审批列表 功能描述： 展示审批任务总览，便于审批管理。

功能要求：

展示 API 使用审批列表。 展示 API 发布审批列表。 支持查看申请人、申请时间、审批状态等信息。 支持根据审批状态筛选。 4.3.3 审批管理-自定义审批流 功能描述： 支持根据审批类型配置审批流。

功能要求：

支持配置审批人。 支持配置审批顺序。 支持配置审批条件。 支持针对不同审批类型配置不同流程。 审批流程应满足灵活配置与可维护要求。 4.4 我的 API 管理模块 面向 API 提供者，承担 API 创建、测试、发布、下线、详情查看等能力。

4.4.1 API 创建 功能描述： 支持创建应用 API、数据 API、汇聚 API 等类型 API。

功能要求：

支持录入 API 基本信息。 基本信息包括：API 名称、API 图标、API 描述、业务分类、发布机构、请求方式、可见范围、返回格式。 支持配置请求参数。 支持选择工作表。 支持配置返回参数。 支持配置错误码及描述。 支持配置流量控制规则。 支持 API 测试。 支持配置成功/失败返回示例。 支持保存正确示例与错误示例。 4.4.2 我的 API-API 详情查看 功能描述： 支持 API 提供者按状态查看和管理自己发布的 API。

功能要求：

支持全部、待发布、已发布、审批中等状态筛选。 支持分页查看。 支持查看详情。 待发布状态下支持编辑、发布、删除。 已发布状态下支持下线。 审批中状态下支持撤回。 4.5 接口授权与访问控制模块 面向 API 使用者与管理员，承担授权状态管理、token 管理、访问控制等能力。

4.5.1 接口授权-授权状态管理 功能描述： 统一管理 API 授权状态。

功能要求：

支持全部状态查看。 支持已过期状态查看。 支持生效中状态查看。 4.5.2 接口授权-生效中状态 功能描述： 展示当前生效中的 API 授权信息。

功能要求：

支持查看当前授权 token。 支持重置 token。 重置后需更新授权令牌。 4.5.3 接口授权-已过期状态 功能描述： 支持对过期授权重新申请。

功能要求：

已过期授权支持重新申请 API。 4.5.4 接口访问控制 功能描述： 对 API 使用者访问进行安全控制。

功能要求：

支持 API 使用者启用/停用控制。 支持编辑访问控制信息。 控制信息包括申请期限、访问 IP 控制、流量控制。 满足 API 访问安全与资源合理利用要求。 4.5.5 接口授权-操作记录 功能描述： 记录用户围绕授权的关键操作。

功能要求：

记录查看 token 操作。 记录重置 token 操作。 记录评分等操作。 支持管理员和用户查看操作记录。 4.6 监控统计与日志模块 面向管理员与运营人员，承担 API 运行分析、调用监控、行为追踪等能力。

4.6.1 共享接口统计 功能描述： 对 API 使用情况进行多维统计和分析。

功能要求：

提供 API 调用趋势分布。 提供 API 调用健康分布。 提供用户活跃度。 提供 API 调用活跃度。 提供用户活跃量。 提供 API 错误分布。 提供 API 响应时间最慢排行。 提供 API 调用活跃度二级列表。 提供 API 调用活跃度二级列表-API 详情。 提供用户活跃量二级列表。 提供用户活跃量二级列表-用户调用 API 清单。 4.6.2 接口服务调用日志 功能描述： 记录 API 服务调用过程及关联信息。

功能要求：

支持 API 使用者关联与查看。 支持 API 访问管理。 支持展示申请信息。 支持展示审批信息。 支持展示修改记录。 提升系统安全性与可管理性。 4.6.3 接口操作日志 功能描述： 记录用户对 API 授权及相关功能的操作行为。

功能要求：

记录查看行为。 记录重置 token 行为。 记录评分行为。 支持管理员和用户查看自身使用情况。 4.7 API 推荐运营模块 面向运营/管理员，承担 API 推荐配置与权重管理能力。

4.7.1 API 推荐管理-API 发布列表 功能描述： 管理和展示可参与推荐的 API 列表。

功能要求：

展示 API 名称、用途、接口地址、请求方法、请求参数等详细信息。 支持查看发布列表。 4.7.2 API 推荐管理-推荐/取消推荐 功能描述： 支持对 API 推荐状态进行运营调整。

功能要求：

支持将 API 设置为推荐。 支持取消 API 推荐状态。 推荐状态应影响首页或推荐区域展示。 4.7.3 API 推荐管理-修改权重值 功能描述： 支持通过权重控制 API 推荐优先级。

功能要求：

支持修改权重值。 权重值用于控制展示优先级或资源分配优先级。 4.8 公共基础能力模块 为各业务模块提供公共支撑能力。

4.8.1 用户与角色能力 支持 API 使用者、提供者、审批人员、管理员等角色区分。 支持基于角色展示不同菜单与操作权限。 4.8.2 状态流转能力 支持待审批、审批中、已驳回、已撤回、已通过、生效中、已过期、待发布、已发布、已下线等状态管理。 各业务对象状态流转需统一定义。 4.8.3 消息与提醒能力 审批提交、审批通过、审批驳回、授权到期、发布结果等场景建议纳入消息提醒能力。 4.8.4 文件与附件能力 支持 API 图标上传。 支持示例代码文件下载。 支持必要申请材料或附件扩展能力。 5. 模块优先级建议 4.9 面向落地的实施模块拆分建议 为便于后续立项、排期、前后端分工与接口设计，建议将上述业务能力进一步拆分为以下实施模块：

模块 A：门户首页与 API 发现 范围：

API 搜索 热门 API 最新 API 推荐 API API 分类与排序 API 列表 前端重点：

首页门户 搜索页 分类列表页 推荐专区 后端重点：

API 查询接口 搜索条件接口 分类/排序接口 热门/最新/推荐聚合接口 落地价值： 优先建立 API 市场门户入口，支撑用户快速发现 API。

模块 B：API 详情与接入资料 范围：

API 详情 请求说明 响应示例 错误码 流量控制说明 示例代码下载 发布人/技术负责人/联系方式展示 前端重点：

API 详情页 示例与文档展示区 下载入口 后端重点：

API 详情查询接口 示例代码下载接口 统计字段更新接口（浏览次数等） 落地价值： 形成从“发现 API”到“理解 API”的接入链路。

模块 C：API 使用申请与申请管理 范围：

API 使用申请 我的申请-使用申请列表 撤回/编辑/查看审批结果 前端重点：

申请弹窗/表单 我的申请列表页 申请详情页 后端重点：

使用申请提交接口 使用申请查询接口 撤回接口 编辑接口 状态流转处理 落地价值： 打通用户申请授权的业务入口。

模块 D：审批中心与审批流配置 范围：

审批工单 使用/发布审批列表 审批通过/驳回 驳回原因填写 自定义审批流 前端重点：

审批待办列表 审批详情页 审批流配置页 后端重点：

审批任务接口 审批动作接口 审批记录接口 审批流配置接口 落地价值： 保证申请与发布流程合规、可追踪、可运营。

模块 E：API 创建与发布管理 范围：

API 创建 请求参数配置 返回参数配置 错误码配置 流控配置 API 测试 返回示例维护 我的 API 列表 编辑、发布、删除、下线、撤回 我的申请-发布申请列表 前端重点：

API 创建/编辑页 参数配置页签 测试与示例页签 我的 API 列表 后端重点：

API 新增/编辑接口 参数配置保存接口 发布申请接口 API 状态管理接口 API 测试支撑接口 落地价值： 形成 API 从创建到发布的完整供给能力。

模块 F：授权与访问控制 范围：

授权状态管理 生效中/已过期授权 token 查看与重置 启用/停用控制 访问 IP 控制 流量控制 授权操作记录 前端重点：

授权列表页 token 管理页 访问控制编辑页 操作记录页 后端重点：

授权查询接口 token 重置接口 访问控制配置接口 授权状态计算接口 授权日志接口 落地价值： 保障 API 调用安全与授权生命周期管理。

模块 G：监控统计与日志审计 范围：

共享接口统计 API 调用趋势、健康、错误、活跃度 用户活跃量分析 服务调用日志 接口操作日志 前端重点：

监控大盘 二级分析列表 日志查询页 后端重点：

统计分析接口 调用日志查询接口 操作日志查询接口 指标聚合任务/定时任务 落地价值： 支撑平台运维、问题追踪与运营分析。

模块 H：推荐运营管理 范围：

API 发布列表 推荐/取消推荐 权重调整 前端重点：

推荐管理列表页 权重编辑弹窗 后端重点：

推荐配置接口 权重保存接口 推荐结果查询接口 落地价值： 支撑平台重点 API 运营推广。

模块 I：公共支撑能力 范围：

用户与角色权限 状态机/状态流转 消息提醒 文件上传下载 基础字典/分类配置 前端重点：

通用字典加载 上传组件 权限控制 后端重点：

统一状态控制 文件服务 权限校验 通知能力 落地价值： 为各业务模块提供统一基础设施支撑。

5. 模块优先级建议 5.1 一期优先建设模块 建议优先落地与核心业务闭环直接相关的模块：

API 市场门户模块 API 使用申请与我的申请模块 审批工单与审批管理模块 我的 API 管理模块 接口授权与访问控制模块 5.2 二期增强模块 建议在核心流程稳定后建设：

监控统计与日志模块 API 推荐运营模块 自定义审批流高级能力 消息提醒与运营增强能力 6. 关键业务对象建议 为后续设计做准备，建议重点抽象以下业务对象：

API 基础信息 API 分类信息 API 请求参数 API 返回参数 API 错误码 API 示例代码 API 使用申请 API 发布申请 审批工单 审批流程配置 API 授权信息 API token 信息 API 访问控制规则 API 调用日志 API 操作日志 API 推荐配置 API 统计指标 7. 后续落地建议 7.1 产品设计阶段 基于本文档输出页面清单。 基于模块梳理页面原型。 明确字段级表单设计与状态流转图。 7.2 技术设计阶段 按模块拆分前后端开发范围。 梳理后端实体、请求对象、返回对象与接口清单。 梳理前端页面、路由、接口封装与状态管理。 明确审批流、授权、日志、统计等核心数据模型。 7.3 实施排期阶段 建议以“核心闭环优先、运营增强后置”为原则分阶段推进：

阶段一：市场展示 + 详情 + 使用申请 + 审批 + 授权 阶段二：API 创建 + 发布审批 + 我的 API 管理 阶段三：监控统计 + 推荐运营 + 高级审批流 8. 功能模块清单汇总 一级模块 二级功能 API 市场门户模块 API 搜索、热门 API、最新 API、推荐 API、API 分类与排序、API 列表、API 详情、示例代码下载 API 使用申请与我的申请模块 API 使用申请、我的申请-使用申请列表、我的申请-发布申请列表 审批工单与审批管理模块 审批工单、审批列表、自定义审批流 我的 API 管理模块 API 创建、我的 API 详情查看与状态管理 接口授权与访问控制模块 授权状态管理、生效中授权、已过期授权、访问控制、授权操作记录 监控统计与日志模块 共享接口统计、接口服务调用日志、接口操作日志 API 推荐运营模块 API 发布列表、推荐/取消推荐、权重管理 公共基础能力模块 用户角色、状态流转、消息提醒、文件附件 9. 验收口径建议 后续各模块验收建议至少覆盖以下维度：

功能是否完整覆盖需求场景。 状态流转是否正确。 权限控制是否符合角色边界。 关键数据是否可追踪、可查询、可审计。 页面操作链路是否闭环。 API 调用、授权、审批等关键节点是否具备日志与统计支撑。 10. 页面清单建议 为便于原型、菜单、路由与开发任务拆分，建议页面按角色拆分如下。

10.1 API 使用者侧页面 页面名称 页面说明 核心功能 API 市场首页 平台门户首页 搜索入口、热门 API、最新 API、推荐 API、分类导航 API 搜索结果页 展示搜索结果 名称/路径/描述搜索、筛选、排序、跳转详情 API 分类列表页 按分类查看 API 分类切换、排序、分页、列表展示 API 详情页 查看 API 详细信息 文档说明、参数、示例、错误码、申请入口、示例代码下载 API 使用申请弹窗/页 提交 API 使用申请 应用选择、申请理由、IP 网段、流量策略 我的申请-使用申请列表页 查看个人 API 使用申请 列表查询、状态筛选、撤回、编辑、查看详情 我的申请-使用申请详情页 查看申请明细 申请信息、审批信息、驳回原因、状态流转 接口授权列表页 查看 API 授权 全部/生效中/已过期筛选、查看授权状态 授权详情页 查看具体授权信息 token 查看、调用信息、授权期限、访问控制 操作记录页 查看授权相关操作记录 查看 token、重置 token、评分等记录 10.2 API 提供者侧页面 页面名称 页面说明 核心功能 我的 API 列表页 管理个人 API 全部/待发布/已发布/审批中筛选、分页、查看详情 API 创建页 新建 API 基本信息、参数配置、错误码、流控、测试示例 API 编辑页 编辑已有 API 编辑基本信息、参数、示例、发布前校验 API 测试页/页签 测试 API 配置效果 发起测试、查看成功/失败示例 API 详情管理页 提供者查看 API 详情 详情查看、发布、下线、撤回、删除 我的申请-发布申请列表页 查看 API 发布申请 状态筛选、撤回、编辑、查看审批结果 我的申请-发布申请详情页 查看发布申请详情 申请信息、审批进度、驳回原因 10.3 审批人员侧页面 页面名称 页面说明 核心功能 审批工单列表页 展示待办/已办工单 使用审批、发布审批、状态筛选、申请人筛选 审批工单详情页 处理审批工单 查看申请信息、审批记录、通过/驳回、填写驳回理由 审批管理列表页 审批任务总览 使用/发布审批统一管理 自定义审批流配置页 配置审批流程 审批人、顺序、条件、审批类型配置 10.4 运营/管理员侧页面 页面名称 页面说明 核心功能 推荐管理列表页 管理推荐 API 列表查询、推荐/取消推荐、权重设置 推荐权重设置弹窗/页 调整推荐权重 修改权重值、保存排序优先级 共享接口统计大盘页 查看平台监控统计 调用趋势、健康度、错误分布、活跃度 API 调用活跃度二级列表页 查看 API 调用活跃度明细 API 明细列表、详情跳转 用户活跃量二级列表页 查看用户活跃明细 用户维度调用统计、用户调用 API 清单 接口服务调用日志页 查看 API 调用日志 日志查询、申请信息、审批信息、修改记录 接口操作日志页 查看操作行为日志 查看/重置 token/评分等日志 接口访问控制管理页 管理 API 访问控制 启用/停用、访问期限、IP 控制、流控配置 10.5 公共/通用页面 页面名称 页面说明 核心功能 文件上传组件页签/弹窗 上传图标或附件 图标上传、附件管理 示例代码下载入口 下载示例代码 文件下载 消息通知中心 查看审批和授权消息 审批提交、通过、驳回、到期提醒 11. 接口清单建议 以下为面向实施的后端接口分组建议，接口路径命名可在正式设计阶段结合现有项目规范调整，统一建议沿用 /api/ 前缀。

11.1 API 市场门户类接口 接口名称 方法 建议路径 说明 API 搜索 GET /api/market/api/search 按名称、路径、描述模糊搜索 API API 列表查询 GET /api/market/api/page 分页查询 API 列表 热门 API 查询 GET /api/market/api/hot/list 查询热门 API 最新 API 查询 GET /api/market/api/latest/list 查询最新 API 推荐 API 查询 GET /api/market/api/recommend/list 查询推荐 API API 分类查询 GET /api/market/api/category/list 查询 API 分类 API 详情查询 GET /api/market/api/detail 查询 API 详情 API 浏览量记录 POST /api/market/api/view 记录 API 浏览行为 示例代码下载 GET /api/market/api/example/download 下载 API 示例代码 11.2 API 使用申请类接口 接口名称 方法 建议路径 说明 提交 API 使用申请 POST /api/apply/use/submit 提交 API 使用申请 使用申请分页查询 GET /api/apply/use/page 查询我的使用申请列表 使用申请详情查询 GET /api/apply/use/detail 查询使用申请详情 撤回使用申请 POST /api/apply/use/withdraw 撤回审批中的使用申请 编辑使用申请 POST /api/apply/use/update 编辑已撤回或已驳回申请 11.3 API 发布申请与我的 API 管理接口 接口名称 方法 建议路径 说明 创建 API POST /api/provider/api/save 新增 API 编辑 API POST /api/provider/api/update 编辑 API API 分页查询 GET /api/provider/api/page 查询我的 API 列表 API 详情查询 GET /api/provider/api/detail 查询我的 API 详情 删除 API POST /api/provider/api/delete 删除待发布 API 提交发布申请 POST /api/provider/api/publish 提交 API 发布申请 下线 API POST /api/provider/api/offline 下线已发布 API 撤回发布申请 POST /api/provider/api/withdraw 撤回审批中的发布申请 发布申请分页查询 GET /api/apply/publish/page 查询发布申请列表 发布申请详情查询 GET /api/apply/publish/detail 查询发布申请详情 API 测试 POST /api/provider/api/test 执行 API 测试 11.4 审批管理类接口 接口名称 方法 建议路径 说明 审批工单分页查询 GET /api/approval/workorder/page 查询审批工单列表 审批工单详情查询 GET /api/approval/workorder/detail 查询审批工单详情 审批通过 POST /api/approval/workorder/pass 审批通过 审批驳回 POST /api/approval/workorder/reject 审批驳回并填写原因 审批记录查询 GET /api/approval/record/list 查询审批记录 审批流配置分页查询 GET /api/approval/process/page 查询审批流配置 审批流配置保存 POST /api/approval/process/save 新增或编辑审批流配置 审批流配置详情 GET /api/approval/process/detail 查询审批流详情 审批流配置启停 POST /api/approval/process/status 启用或停用审批流 11.5 授权与访问控制类接口 接口名称 方法 建议路径 说明 授权列表查询 GET /api/auth/grant/page 查询授权列表 授权详情查询 GET /api/auth/grant/detail 查询授权详情 重置 token POST /api/auth/grant/resetToken 重置授权 token 重新申请授权 POST /api/auth/grant/reapply 对过期授权重新申请 修改访问控制 POST /api/auth/access/update 修改申请期限、IP、流控等信息 启用/停用授权 POST /api/auth/access/status 启用或停用 API 使用者访问 授权操作记录查询 GET /api/auth/operateLog/page 查询授权相关操作日志 11.6 推荐运营类接口 接口名称 方法 建议路径 说明 推荐 API 列表查询 GET /api/recommend/api/page 查询推荐管理 API 列表 设置推荐状态 POST /api/recommend/api/status 推荐/取消推荐 修改推荐权重 POST /api/recommend/api/weight 修改 API 推荐权重 11.7 监控统计与日志类接口 接口名称 方法 建议路径 说明 API 调用趋势统计 GET /api/stat/api/trend 查询调用趋势 API 调用健康统计 GET /api/stat/api/health 查询调用健康分布 API 错误分布统计 GET /api/stat/api/error 查询 API 错误分布 API 活跃度统计 GET /api/stat/api/activity 查询 API 活跃度 用户活跃量统计 GET /api/stat/user/activity 查询用户活跃量 慢响应 API 排行 GET /api/stat/api/slowTop 查询响应时间最慢 API API 活跃度明细列表 GET /api/stat/api/activity/page 查询 API 活跃度明细 用户活跃明细列表 GET /api/stat/user/activity/page 查询用户活跃明细 用户调用 API 清单 GET /api/stat/user/api/list 查询用户调用 API 清单 服务调用日志查询 GET /api/log/service/page 查询 API 服务调用日志 操作日志查询 GET /api/log/operate/page 查询接口操作日志 11.8 公共能力类接口 接口名称 方法 建议路径 说明 分类字典查询 GET /api/common/category/list 查询 API 分类等基础字典 应用列表查询 GET /api/common/app/list 查询可选应用 文件上传 POST /api/common/file/upload 上传 API 图标或附件 文件下载 GET /api/common/file/download 下载附件文件 消息列表查询 GET /api/common/message/page 查询通知消息 消息已读 POST /api/common/message/read 标记消息已读 12. 数据表清单建议 以下为后续数据库设计建议关注的核心表，名称可在落库阶段结合现有命名规范调整。

12.1 API 基础主数据表 表名建议 说明 核心字段建议 api_info API 基础信息表 id、api_name、api_icon、api_desc、api_type、category_id、publisher_org、request_method、visible_scope、response_format、status、publish_time、view_count api_category API 分类表 id、category_name、category_code、sort、status api_param_request API 请求参数表 id、api_id、param_name、param_type、required_flag、default_value、example_value、sort api_param_response API 返回参数表 id、api_id、field_name、field_type、field_desc、example_value、sort api_error_code API 错误码表 id、api_id、error_code、error_msg、error_desc、sort api_example_code API 示例代码表 id、api_id、file_name、file_path、file_type、version api_flow_control API 流控配置表 id、api_id、limit_type、limit_value、time_unit、status api_test_example API 测试与示例表 id、api_id、example_type、request_example、response_example、status 12.2 API 申请与审批表 表名建议 说明 核心字段建议 api_use_apply API 使用申请表 id、api_id、app_id、apply_user_id、apply_reason、access_ip_range、flow_strategy、apply_status、current_approval_node api_publish_apply API 发布申请表 id、api_id、apply_user_id、apply_status、apply_time、current_approval_node approval_workorder 审批工单表 id、business_type、business_id、apply_id、applicant_id、status、current_node、submit_time、finish_time approval_record 审批记录表 id、workorder_id、approver_id、approval_action、approval_opinion、approval_time、node_no approval_process 审批流配置主表 id、process_name、process_type、status、condition_json approval_process_node 审批流配置节点表 id、process_id、node_no、approver_type、approver_id、condition_json 12.3 授权与访问控制表 表名建议 说明 核心字段建议 api_auth_grant API 授权表 id、api_id、apply_id、user_id、app_id、grant_status、effective_time、expire_time、token_value api_access_control API 访问控制表 id、grant_id、enable_status、access_ip_range、flow_limit_rule、apply_deadline api_token_reset_log token 重置日志表 id、grant_id、old_token、new_token、operate_user_id、operate_time api_auth_operate_log 授权操作日志表 id、grant_id、operate_type、operate_user_id、operate_desc、operate_time 12.4 日志与统计表 表名建议 说明 核心字段建议 api_service_call_log API 服务调用日志表 id、api_id、grant_id、caller_user_id、request_time、response_time、duration_ms、result_code、result_msg api_service_change_log API 服务变更记录表 id、api_id、change_type、change_content、operate_user_id、operate_time api_operate_log API 操作日志表 id、api_id、business_type、operate_type、operate_user_id、operate_time、operate_desc api_stat_daily API 统计日报表 id、stat_date、api_id、call_count、apply_count、view_count、error_count、avg_duration user_api_stat_daily 用户 API 统计日报表 id、stat_date、user_id、api_id、call_count、success_count、error_count 12.5 推荐与公共能力表 表名建议 说明 核心字段建议 api_recommend_config API 推荐配置表 id、api_id、recommend_status、weight_value、recommend_type、start_time、end_time message_notice 消息通知表 id、message_type、receive_user_id、message_title、message_content、read_status、send_time file_record 文件记录表 id、biz_type、biz_id、file_name、file_path、file_size、upload_user_id、upload_time app_info 应用信息表 id、app_name、app_code、owner_user_id、status 13. 关键状态流转建议 13.1 API 使用申请状态 草稿 待审批 审批中 已通过 已驳回 已撤回 13.2 API 发布状态 待发布 审批中 已发布 已下线 已驳回 已撤回 13.3 API 授权状态 待生效 生效中 已停用 已过期 13.4 审批工单状态 待处理 审批中 已通过 已驳回 已关闭 14. 迭代拆分建议 14.1 第一阶段：核心闭环 API 市场首页 API 搜索/列表/详情 API 使用申请 审批工单处理 授权列表与 token 查看 14.2 第二阶段：供给侧闭环 API 创建/编辑/测试 发布申请与审批 我的 API 管理 访问控制配置 14.3 第三阶段：运营与分析增强 推荐管理 统计大盘 服务调用日志 操作日志 自定义审批流 15. 下一步输出建议 如果继续推进，建议下一批产出物按以下顺序补齐：

页面原型清单与菜单结构 字段级表单设计 后端实体/Request/VO 清单 接口入参与出参样例 数据库字段明细设计 状态流转图与审批流图 16. 菜单结构建议 结合前述角色与功能模块，建议前端菜单按以下结构组织。

16.1 API 使用者菜单 API 市场 市场首页 API 搜索 API 分类 热门 API 最新 API 推荐 API 我的申请 API 使用申请列表 API 发布申请列表 接口授权 授权状态管理 生效中授权 已过期授权 操作记录 消息中心 通知消息 16.2 API 提供者菜单 我的 API API 列表 创建 API API 详情管理 我的申请 API 发布申请列表 16.3 审批人员菜单 审批管理 审批工单 API 使用审批列表 API 发布审批列表 自定义审批流 16.4 运营/管理员菜单 推荐运营 API 发布列表 推荐管理 统计分析 共享接口统计 API 活跃度分析 用户活跃量分析 日志管理 接口服务调用日志 接口操作日志 访问控制 接口访问控制管理 系统消息 通知消息 16.5 菜单权限建议 菜单模块 API 使用者 API 提供者 审批人员 管理员 API 市场 有 可选 可选 有 我的申请 有 有 可选 有 我的 API 无 有 无 有 审批管理 无 无 有 有 推荐运营 无 无 可选 有 统计分析 无 可选 可选 有 日志管理 无 无 可选 有 访问控制 无 无 可选 有 消息中心 有 有 有 有 17. 页面原型说明建议 以下内容可直接作为后续页面原型设计说明。

17.1 API 市场首页原型说明 页面目标： 帮助用户快速发现可用 API。

页面区域建议：

顶部搜索区 搜索框 搜索类型切换（名称/路径/描述） 热门 API 区 卡片列表 展示图标、名称、评分、描述、调用次数 最新 API 区 列表或卡片展示 推荐 API 区 分类切换：全部、应用 API、数据 API、模型 API、汇聚 API 分类导航区 分类入口 排序快捷入口 页面操作：

输入关键词后跳转搜索结果页。 点击卡片进入 API 详情页。 点击分类进入分类列表页。 17.2 API 搜索结果页原型说明 页面目标： 展示 API 搜索结果并支持进一步筛选。

页面区域建议：

搜索条件区 关键词输入框 搜索类型选择 筛选区 API 分类 API 类型 排序区 调用次数 申请次数 发布时间 浏览次数 用户评分 结果列表区 API 图标 API 名称 API 描述 评分 申请次数/调用次数 分页区 页面操作：

修改条件实时查询或点击查询按钮。 点击 API 进入详情页。 17.3 API 详情页原型说明 页面目标： 完整展示 API 资料并支持发起使用申请。

页面区域建议：

基本信息区 API 图标 API 名称 API 描述 发布机构 发布人 技术负责人 联系方式 统计信息区 浏览次数 申请次数 调用次数 评分 文档说明区 创作思路 数据结构 使用方法 请求参数区 返回参数区 响应示例区 错误码区 流量控制说明区 示例代码下载区 操作区 申请使用 下载示例代码 页面操作：

点击申请使用弹出申请表单。 点击示例代码执行下载。 17.4 API 使用申请页原型说明 页面目标： 完成 API 使用授权申请。

页面区域建议：

API 基本信息摘要 申请表单区 提交操作区 页面操作：

选择应用。 填写申请理由、访问 IP 网段、流量策略。 提交成功后提示并跳转我的申请列表。 17.5 我的申请列表页原型说明 页面目标： 统一管理用户提交的申请。

页面区域建议：

筛选区 申请类型 申请状态 时间范围 列表区 申请单号 API 名称 申请时间 审批状态 当前节点 操作按钮 分页区 页面操作：

审批中支持撤回。 已撤回、已驳回支持编辑。 点击查看详情页。 17.6 我的 API 列表页原型说明 页面目标： 帮助提供者管理自己创建和发布的 API。

页面区域建议：

顶部操作区 创建 API 按钮 筛选区 状态筛选 分类筛选 关键词查询 列表区 API 名称 类型 状态 创建时间 更新时间 操作按钮 分页区 页面操作：

待发布：编辑、删除、发布。 已发布：查看详情、下线。 审批中：查看详情、撤回。 17.7 API 创建/编辑页原型说明 页面目标： 配置 API 从基础资料到参数、示例、流控的完整信息。

页面布局建议： 采用分步页签或分段表单：

基本信息 请求参数 返回参数 错误码 流控配置 API 测试 返回示例 页面操作：

保存草稿。 提交发布。 进行 API 测试。 保存成功示例和失败示例。 17.8 审批工单详情页原型说明 页面目标： 支撑审批人员查看申请并执行审批动作。

页面区域建议：

工单基本信息区 申请信息区 审批流区 审批记录区 审批操作区 通过 驳回 驳回原因输入框 页面操作：

填写审批意见。 驳回时必须填写原因。 提交后更新状态和审批记录。 17.9 授权列表与授权详情页原型说明 页面目标： 帮助用户查看授权状态与调用凭证。

授权列表页区域建议：

状态筛选区 授权列表区 分页区 授权详情页区域建议：

API 信息区 授权信息区 token 生效时间 失效时间 授权状态 访问控制区 访问 IP 流量策略 启用/停用状态 操作记录区 操作按钮 重置 token 重新申请 17.10 统计大盘页原型说明 页面目标： 为管理员提供 API 运行与使用情况的总览分析。

页面区域建议：

顶部筛选区 时间范围 API 分类 API 名称 指标卡片区 总调用量 总申请量 活跃用户数 错误数 图表区 调用趋势图 健康分布图 错误分布图 活跃度排行图 明细入口区 API 活跃度明细 用户活跃量明细 慢响应排行 18. 字段级表单设计建议 18.1 API 使用申请表单 字段名称 字段标识建议 类型 必填 说明 API ID apiId hidden / string 是 当前申请的 API 标识 API 名称 apiName text 否 只读展示 应用选择 appId select 是 选择使用该 API 的应用 申请理由 applyReason textarea 是 说明使用场景与目的 访问 IP 网段 accessIpRange input 是 支持单个 IP、IP 段或 CIDR 流量策略 flowStrategy textarea / select 是 填写调用频率或流量说明 附件 attachmentIds upload 否 可选扩展材料 校验建议：

应用选择不能为空。 申请理由长度建议 10~500 字。 访问 IP 网段需校验格式。 流量策略不能为空。 18.2 API 创建基础信息表单 字段名称 字段标识建议 类型 必填 说明 API 名称 apiName input 是 API 展示名称 API 图标 apiIcon upload 否 API 图标 API 描述 apiDesc textarea 是 API 简介 API 类型 apiType select 是 应用 API / 数据 API / 模型 API / 汇聚 API 业务分类 categoryId select 是 所属分类 发布机构 publisherOrg input 是 所属机构 请求方式 requestMethod select 是 GET / POST / PUT / DELETE 等 接口路径 apiPath input 是 API 访问路径 可见范围 visibleScope radio/select 是 全部可见/指定可见 返回格式 responseFormat select 是 JSON / XML / 文件流等 技术负责人 techOwner input 是 技术负责人姓名 联系方式 contactInfo input 是 电话/邮箱等 创作思路 designIdea textarea 否 API 背景说明 数据结构说明 dataStructureDesc textarea 否 数据结构说明 使用方法 useGuide textarea 否 调用说明 校验建议：

API 名称不可重复。 接口路径需符合路径格式。 联系方式需校验邮箱/手机号格式。 18.3 API 请求参数表单 字段名称 字段标识建议 类型 必填 说明 参数名称 paramName input 是 请求参数名 参数编码 paramCode input 否 若项目区分展示名与编码时使用 参数类型 paramType select 是 string/int/boolean/object/array 等 是否必填 requiredFlag switch 是 必填标识 默认值 defaultValue input 否 默认值 示例值 exampleValue input/textarea 否 示例值 参数说明 paramDesc textarea 否 参数含义 排序号 sort number 否 展示顺序 18.4 API 返回参数表单 字段名称 字段标识建议 类型 必填 说明 字段名称 fieldName input 是 返回字段名 字段类型 fieldType select 是 string/int/object/array 等 字段说明 fieldDesc textarea 否 字段业务含义 示例值 exampleValue input/textarea 否 示例内容 排序号 sort number 否 展示顺序 18.5 API 错误码表单 字段名称 字段标识建议 类型 必填 说明 错误码 errorCode input 是 错误编码 错误信息 errorMsg input 是 错误简述 错误说明 errorDesc textarea 否 详细说明 排序号 sort number 否 展示顺序 18.6 API 流控配置表单 字段名称 字段标识建议 类型 必填 说明 限流类型 limitType select 是 按秒/按分/按小时/按日 限流值 limitValue number 是 限流阈值 时间单位 timeUnit select 是 second/minute/hour/day 生效状态 status switch 是 是否启用 说明 remark textarea 否 规则说明 18.7 审批处理表单 字段名称 字段标识建议 类型 必填 说明 工单 ID workorderId hidden / string 是 当前审批工单 审批动作 approvalAction radio 是 通过 / 驳回 审批意见 approvalOpinion textarea 否 审批说明 驳回原因 rejectReason textarea 条件必填 驳回时必填 校验建议：

驳回时必须填写驳回原因。 审批动作不能为空。 18.8 访问控制编辑表单 字段名称 字段标识建议 类型 必填 说明 授权 ID grantId hidden / string 是 当前授权标识 启用状态 enableStatus switch 是 启用/停用 申请期限 applyDeadline daterange / datetime 否 可配置授权有效期 访问 IP 控制 accessIpRange input 否 IP 白名单范围 流量控制规则 flowLimitRule textarea 否 访问控制策略 备注 remark textarea 否 补充说明 18.9 推荐配置表单 字段名称 字段标识建议 类型 必填 说明 API ID apiId hidden / string 是 当前 API 推荐状态 recommendStatus switch 是 是否推荐 推荐类型 recommendType select 否 首页推荐/分类推荐等 权重值 weightValue number 是 值越大优先级越高 生效时间 startTime datetime 否 推荐开始时间 失效时间 endTime datetime 否 推荐结束时间 19. 页面与接口映射建议 页面名称 主要接口 API 市场首页 热门 API 查询、最新 API 查询、推荐 API 查询、分类字典查询 API 搜索结果页 API 搜索、API 列表查询、API 分类查询 API 详情页 API 详情查询、API 浏览量记录、示例代码下载 API 使用申请页 应用列表查询、提交 API 使用申请 我的申请列表页 使用申请分页查询、发布申请分页查询、撤回使用申请、编辑使用申请 我的 API 列表页 API 分页查询、API 详情查询、提交发布申请、下线 API、删除 API API 创建/编辑页 创建 API、编辑 API、API 测试、文件上传、分类字典查询 审批工单详情页 审批工单详情查询、审批通过、审批驳回、审批记录查询 授权详情页 授权详情查询、重置 token、修改访问控制、授权操作记录查询 推荐管理页 推荐 API 列表查询、设置推荐状态、修改推荐权重 统计大盘页 API 调用趋势统计、API 调用健康统计、API 错误分布统计、用户活跃量统计 20. 开发准备建议 为进入详细设计和研发阶段，建议优先再补充以下内容：

每个页面的字段字典来源。 每个接口的入参与出参 JSON 样例。 每张核心表的字段长度、索引、是否可空、默认值。 申请、审批、授权、发布四类核心状态机。 前端路由命名与菜单权限码设计。 后端 Controller / Service / Request / VO 拆分清单。 21. 核心接口设计稿 以下示例采用项目现有后端常见响应包装风格进行整理，建议统一使用 R.data(...) / R.success(...) 风格返回。JSON 样例主要用于前后端联调和字段确认，正式落地时可结合实际实体字段微调。

21.1 API 搜索接口 接口信息：

方法：GET 路径：/api/market/api/search 说明：按 API 名称、路径、描述进行模糊搜索。 请求参数示例：

{ "keyword": "交通", "searchType": "name", "categoryId": "1001", "apiType": "data", "sortBy": "callCount", "sortOrder": "desc", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 2, "size": 10, "current": 1, "records": [ { "apiId": "api_10001", "apiName": "道路实时路况查询", "apiIcon": "/file/api/road.png", "apiDesc": "提供道路拥堵指数、平均车速等实时路况信息", "apiType": "data", "categoryId": "1001", "categoryName": "交通出行", "requestMethod": "GET", "apiPath": "/openapi/traffic/road/status", "score": 4.8, "applyCount": 135, "callCount": 12890, "viewCount": 5620, "publishTime": "2026-04-01 10:00:00" } ] } } 21.2 API 详情查询接口 接口信息：

方法：GET 路径：/api/market/api/detail 说明：查询 API 详情信息。 请求参数示例：

{ "apiId": "api_10001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "apiId": "api_10001", "apiName": "道路实时路况查询", "apiIcon": "/file/api/road.png", "apiDesc": "提供道路拥堵指数、平均车速等实时路况信息", "apiType": "data", "categoryId": "1001", "categoryName": "交通出行", "publisherOrg": "交管数据中心", "publishUserName": "张三", "techOwner": "李四", "contactInfo": "[email protected]", "requestMethod": "GET", "apiPath": "/openapi/traffic/road/status", "visibleScope": "public", "responseFormat": "JSON", "score": 4.8, "applyCount": 135, "callCount": 12890, "viewCount": 5620, "designIdea": "面向交通业务提供统一路况数据服务能力。", "dataStructureDesc": "返回道路编号、拥堵指数、平均速度等字段。", "useGuide": "调用时传入道路编码和区域编号即可获取实时结果。", "requestParams": [ { "paramName": "roadCode", "paramType": "string", "requiredFlag": 1, "paramDesc": "道路编码", "exampleValue": "G104" } ], "responseParams": [ { "fieldName": "congestionIndex", "fieldType": "number", "fieldDesc": "拥堵指数", "exampleValue": "2.3" } ], "errorCodes": [ { "errorCode": "40001", "errorMsg": "参数错误", "errorDesc": "道路编码不能为空" } ], "flowControl": { "limitType": "minute", "limitValue": 1000, "timeUnit": "minute", "remark": "每分钟最大调用 1000 次" }, "exampleCode": { "fileId": "file_2001", "fileName": "road-demo.zip", "downloadUrl": "/api/market/api/example/download?fileId=file_2001" } } } 21.3 提交 API 使用申请接口 接口信息：

方法：POST 路径：/api/apply/use/submit 说明：提交 API 使用申请。 请求参数示例：

{ "apiId": "api_10001", "appId": "app_3001", "applyReason": "用于交通研判大屏展示道路实时通行情况", "accessIpRange": "10.10.0.0/24", "flowStrategy": "预计峰值每分钟 300 次调用", "attachmentIds": [ "file_9001" ] } 响应结果示例：

{ "code": 200, "success": true, "msg": "申请提交成功", "data": { "applyId": "use_apply_5001", "applyNo": "USE202604230001", "applyStatus": "PENDING", "applyStatusName": "待审批", "submitTime": "2026-04-23 15:00:00" } } 21.4 使用申请分页查询接口 接口信息：

方法：GET 路径：/api/apply/use/page 说明：分页查询我的 API 使用申请。 请求参数示例：

{ "keyword": "路况", "applyStatus": "PENDING", "beginTime": "2026-04-01 00:00:00", "endTime": "2026-04-23 23:59:59", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 1, "size": 10, "current": 1, "records": [ { "applyId": "use_apply_5001", "applyNo": "USE202604230001", "apiId": "api_10001", "apiName": "道路实时路况查询", "appId": "app_3001", "appName": "交通研判平台", "applyStatus": "PENDING", "applyStatusName": "待审批", "currentApprovalNode": "一级审批", "applyTime": "2026-04-23 15:00:00", "rejectReason": "" } ] } } 21.5 创建 API 接口 接口信息：

方法：POST 路径：/api/provider/api/save 说明：保存 API 草稿或新增 API。 请求参数示例：

{ "apiName": "道路实时路况查询", "apiIcon": "/file/api/road.png", "apiDesc": "提供道路拥堵指数、平均车速等实时路况信息", "apiType": "data", "categoryId": "1001", "publisherOrg": "交管数据中心", "requestMethod": "GET", "apiPath": "/openapi/traffic/road/status", "visibleScope": "public", "responseFormat": "JSON", "techOwner": "李四", "contactInfo": "[email protected]", "designIdea": "统一交通路况服务输出。", "dataStructureDesc": "返回道路基础状态与拥堵指数。", "useGuide": "根据 roadCode 查询实时路况。", "requestParams": [ { "paramName": "roadCode", "paramType": "string", "requiredFlag": 1, "defaultValue": "", "exampleValue": "G104", "paramDesc": "道路编码", "sort": 1 } ], "responseParams": [ { "fieldName": "congestionIndex", "fieldType": "number", "fieldDesc": "拥堵指数", "exampleValue": "2.3", "sort": 1 } ], "errorCodes": [ { "errorCode": "40001", "errorMsg": "参数错误", "errorDesc": "道路编码不能为空", "sort": 1 } ], "flowControl": { "limitType": "minute", "limitValue": 1000, "timeUnit": "minute", "status": 1, "remark": "默认每分钟限制 1000 次" }, "testExamples": [ { "exampleType": "SUCCESS", "requestExample": "{"roadCode":"G104"}", "responseExample": "{"code":200,"data":{"congestionIndex":2.3}}" } ], "saveType": "DRAFT" } 响应结果示例：

{ "code": 200, "success": true, "msg": "保存成功", "data": { "apiId": "api_10001", "status": "DRAFT", "statusName": "待发布" } } 21.6 API 分页查询接口（我的 API） 接口信息：

方法：GET 路径：/api/provider/api/page 说明：分页查询我的 API 列表。 请求参数示例：

{ "keyword": "路况", "status": "PUBLISHED", "categoryId": "1001", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 1, "size": 10, "current": 1, "records": [ { "apiId": "api_10001", "apiName": "道路实时路况查询", "apiType": "data", "categoryName": "交通出行", "status": "PUBLISHED", "statusName": "已发布", "createTime": "2026-04-20 09:00:00", "updateTime": "2026-04-22 16:00:00" } ] } } 21.7 提交发布申请接口 接口信息：

方法：POST 路径：/api/provider/api/publish 说明：提交 API 发布申请。 请求参数示例：

{ "apiId": "api_10001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "发布申请提交成功", "data": { "publishApplyId": "publish_apply_6001", "workorderId": "workorder_7001", "status": "APPROVING", "statusName": "审批中" } } 21.8 审批工单详情查询接口 接口信息：

方法：GET 路径：/api/approval/workorder/detail 说明：查询审批工单详情。 请求参数示例：

{ "workorderId": "workorder_7001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "workorderId": "workorder_7001", "businessType": "API_USE_APPLY", "businessTypeName": "API使用申请", "businessId": "use_apply_5001", "status": "PROCESSING", "statusName": "审批中", "applicantId": "user_1001", "applicantName": "王五", "submitTime": "2026-04-23 15:00:00", "currentNode": "一级审批", "formData": { "apiName": "道路实时路况查询", "appName": "交通研判平台", "applyReason": "用于交通研判大屏展示道路实时通行情况", "accessIpRange": "10.10.0.0/24", "flowStrategy": "预计峰值每分钟 300 次调用" }, "approvalRecords": [ { "nodeNo": 1, "nodeName": "一级审批", "approverName": "赵六", "approvalAction": "SUBMIT", "approvalActionName": "提交", "approvalOpinion": "", "approvalTime": "2026-04-23 15:00:00" } ] } } 21.9 审批通过接口 接口信息：

方法：POST 路径：/api/approval/workorder/pass 说明：审批通过。 请求参数示例：

{ "workorderId": "workorder_7001", "approvalOpinion": "符合接入要求，同意开通" } 响应结果示例：

{ "code": 200, "success": true, "msg": "审批通过成功", "data": { "workorderId": "workorder_7001", "status": "PASSED", "statusName": "已通过" } } 21.10 审批驳回接口 接口信息：

方法：POST 路径：/api/approval/workorder/reject 说明：审批驳回。 请求参数示例：

{ "workorderId": "workorder_7001", "approvalOpinion": "申请材料不完整", "rejectReason": "请补充明确的流量预估和访问 IP 白名单" } 响应结果示例：

{ "code": 200, "success": true, "msg": "审批驳回成功", "data": { "workorderId": "workorder_7001", "status": "REJECTED", "statusName": "已驳回" } } 21.11 授权列表查询接口 接口信息：

方法：GET 路径：/api/auth/grant/page 说明：分页查询授权列表。 请求参数示例：

{ "grantStatus": "EFFECTIVE", "keyword": "路况", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 1, "size": 10, "current": 1, "records": [ { "grantId": "grant_8001", "apiId": "api_10001", "apiName": "道路实时路况查询", "appName": "交通研判平台", "grantStatus": "EFFECTIVE", "grantStatusName": "生效中", "effectiveTime": "2026-04-23 18:00:00", "expireTime": "2027-04-23 18:00:00", "enableStatus": 1 } ] } } 21.12 授权详情查询接口 接口信息：

方法：GET 路径：/api/auth/grant/detail 说明：查询授权详情。 请求参数示例：

{ "grantId": "grant_8001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "grantId": "grant_8001", "apiId": "api_10001", "apiName": "道路实时路况查询", "appId": "app_3001", "appName": "交通研判平台", "tokenValue": "sk_test_1234567890", "grantStatus": "EFFECTIVE", "grantStatusName": "生效中", "effectiveTime": "2026-04-23 18:00:00", "expireTime": "2027-04-23 18:00:00", "enableStatus": 1, "enableStatusName": "启用", "accessIpRange": "10.10.0.0/24", "flowLimitRule": "每分钟 300 次", "operateLogs": [ { "operateType": "VIEW_TOKEN", "operateTypeName": "查看Token", "operateUserName": "王五", "operateTime": "2026-04-23 18:10:00" } ] } } 21.13 重置 token 接口 接口信息：

方法：POST 路径：/api/auth/grant/resetToken 说明：重置授权 token。 请求参数示例：

{ "grantId": "grant_8001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "Token重置成功", "data": { "grantId": "grant_8001", "newTokenValue": "sk_test_0987654321", "resetTime": "2026-04-23 18:20:00" } } 21.14 修改访问控制接口 接口信息：

方法：POST 路径：/api/auth/access/update 说明：修改授权访问控制规则。 请求参数示例：

{ "grantId": "grant_8001", "enableStatus": 1, "applyDeadline": "2027-04-23 18:00:00", "accessIpRange": "10.10.0.0/24", "flowLimitRule": "每分钟 300 次", "remark": "调整为生产环境正式白名单" } 响应结果示例：

{ "code": 200, "success": true, "msg": "访问控制修改成功", "data": { "grantId": "grant_8001", "enableStatus": 1, "enableStatusName": "启用" } } 21.15 推荐 API 列表查询接口 接口信息：

方法：GET 路径：/api/recommend/api/page 说明：分页查询推荐运营管理列表。 请求参数示例：

{ "keyword": "路况", "recommendStatus": 1, "categoryId": "1001", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 1, "size": 10, "current": 1, "records": [ { "apiId": "api_10001", "apiName": "道路实时路况查询", "apiType": "data", "categoryName": "交通出行", "recommendStatus": 1, "recommendStatusName": "已推荐", "weightValue": 100, "callCount": 12890, "applyCount": 135 } ] } } 21.16 设置推荐状态接口 接口信息：

方法：POST 路径：/api/recommend/api/status 说明：设置推荐或取消推荐。 请求参数示例：

{ "apiId": "api_10001", "recommendStatus": 1, "recommendType": "HOME" } 响应结果示例：

{ "code": 200, "success": true, "msg": "推荐状态设置成功", "data": { "apiId": "api_10001", "recommendStatus": 1, "recommendStatusName": "已推荐" } } 21.17 共享接口统计接口 接口信息：

方法：GET 路径：/api/stat/api/trend 说明：查询 API 调用趋势统计。 请求参数示例：

{ "beginDate": "2026-04-01", "endDate": "2026-04-23", "categoryId": "1001", "apiId": "api_10001" } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "xAxis": [ "2026-04-21", "2026-04-22", "2026-04-23" ], "series": [ { "name": "调用次数", "data": [ 3200, 3580, 4012 ] } ], "summary": { "totalCallCount": 10792, "avgDailyCallCount": 3597 } } } 21.18 服务调用日志查询接口 接口信息：

方法：GET 路径：/api/log/service/page 说明：分页查询 API 服务调用日志。 请求参数示例：

{ "apiId": "api_10001", "appId": "app_3001", "resultCode": "200", "beginTime": "2026-04-23 00:00:00", "endTime": "2026-04-23 23:59:59", "current": 1, "size": 10 } 响应结果示例：

{ "code": 200, "success": true, "msg": "操作成功", "data": { "total": 1, "size": 10, "current": 1, "records": [ { "logId": "log_9001", "apiId": "api_10001", "apiName": "道路实时路况查询", "appId": "app_3001", "appName": "交通研判平台", "callerUserName": "王五", "requestTime": "2026-04-23 18:30:00", "responseTime": "2026-04-23 18:30:01", "durationMs": 120, "resultCode": "200", "resultMsg": "success" } ] } } 22. 接口字段统一约定建议 22.1 分页字段 请求统一使用：current、size 响应统一返回：total、current、size、records 22.2 状态字段 建议同时返回状态编码和状态名称，例如： status statusName 便于前端直接展示，减少二次映射。 22.3 时间字段 建议统一使用 yyyy-MM-dd HH:mm:ss 格式。 日期统计场景可单独使用 yyyy-MM-dd。 22.4 标识字段 主键统一使用 id 或业务语义化字段，如 apiId、applyId、grantId。 若对接多端，建议同时保留业务编号字段，如 applyNo、workorderNo。 22.5 字典字段 分类、API 类型、审批类型、推荐类型、状态枚举等建议统一由字典接口维护。 23. 接口联调顺序建议 建议按业务闭环优先级进行联调：

23.1 第一批联调 API 搜索接口 API 详情查询接口 提交 API 使用申请接口 使用申请分页查询接口 审批工单详情查询接口 审批通过/驳回接口 授权列表查询接口 授权详情查询接口 23.2 第二批联调 创建 API 接口 API 分页查询接口（我的 API） 提交发布申请接口 修改访问控制接口 重置 token 接口 23.3 第三批联调 推荐 API 列表查询接口 设置推荐状态接口 共享接口统计接口 服务调用日志查询接口 24. 下一步设计建议 如果继续细化，建议下一步直接补以下两部分：

后端实体、Request、VO 清单 每个核心接口对应的 Request/VO 字段定义表 25. 后端分层设计清单 结合当前项目 Spring Boot + BladeX + controller/service/service.impl/data.entity/data.request/data.vo 分层规范，建议后端按以下结构落地。

25.1 Controller 清单建议 类名建议 路径建议 主要职责 ApiMarketController controller API 市场门户相关接口：搜索、列表、热门、最新、推荐、详情、浏览量、示例代码下载 ApiUseApplyController controller API 使用申请相关接口：提交、详情、分页、撤回、编辑 ApiPublishApplyController controller API 发布申请相关接口：分页、详情、撤回 MyApiController controller 我的 API 管理相关接口：创建、编辑、分页、详情、删除、发布、下线、测试 ApprovalWorkorderController controller 审批工单相关接口：分页、详情、通过、驳回、审批记录 ApprovalProcessController controller 自定义审批流配置相关接口：分页、详情、保存、启停 ApiAuthGrantController controller 授权管理相关接口：授权列表、授权详情、重新申请、重置 token ApiAccessControlController controller 访问控制相关接口：启用/停用、控制规则修改 ApiRecommendController controller 推荐运营相关接口：列表、推荐/取消推荐、修改权重 ApiStatController controller 共享接口统计相关接口：趋势、健康、错误、活跃度、慢响应 ApiLogController controller 日志查询相关接口：服务调用日志、操作日志 CommonSupportController controller 通用能力接口：分类字典、应用列表、文件上传下载、消息通知 25.2 Service 接口清单建议 接口名建议 路径建议 主要职责 IApiMarketService service API 市场查询聚合、详情展示、浏览统计 IApiUseApplyService service API 使用申请提交、编辑、撤回、状态流转 IApiPublishApplyService service API 发布申请提交、查询、撤回 IMyApiService service 我的 API 创建、编辑、测试、发布、下线、删除 IApprovalWorkorderService service 审批工单处理、审批流转、审批记录维护 IApprovalProcessService service 审批流配置维护、节点解析、条件匹配 IApiAuthGrantService service 授权生成、授权列表查询、token 管理 IApiAccessControlService service 访问控制规则维护、启停处理、有效期管理 IApiRecommendService service 推荐运营、权重调整、推荐结果输出 IApiStatService service 统计分析、聚合查询、趋势输出 IApiLogService service 服务日志与操作日志查询 ICommonSupportService service 分类字典、文件、消息、应用列表等通用支撑 25.3 ServiceImpl 清单建议 实现类建议 路径建议 说明 ApiMarketServiceImpl service.impl 实现 API 市场查询与详情聚合逻辑 ApiUseApplyServiceImpl service.impl 实现 API 使用申请流程逻辑 ApiPublishApplyServiceImpl service.impl 实现 API 发布申请流程逻辑 MyApiServiceImpl service.impl 实现 API 管理、发布、测试逻辑 ApprovalWorkorderServiceImpl service.impl 实现审批流转和工单处理逻辑 ApprovalProcessServiceImpl service.impl 实现审批流程配置解析与维护 ApiAuthGrantServiceImpl service.impl 实现授权生成、token 重置与状态处理 ApiAccessControlServiceImpl service.impl 实现访问控制编辑和启停逻辑 ApiRecommendServiceImpl service.impl 实现推荐与权重管理逻辑 ApiStatServiceImpl service.impl 实现统计分析查询和聚合 ApiLogServiceImpl service.impl 实现日志分页与筛选查询 CommonSupportServiceImpl service.impl 实现公共字典、文件、消息等能力 26. Entity 清单建议 以下实体建议放在 data/entity 目录，沿用项目现有 Lombok 风格。

26.1 API 主数据实体 实体类建议 对应表建议 说明 ApiInfoEntity api_info API 基础信息实体 ApiCategoryEntity api_category API 分类实体 ApiRequestParamEntity api_param_request API 请求参数实体 ApiResponseParamEntity api_param_response API 返回参数实体 ApiErrorCodeEntity api_error_code API 错误码实体 ApiExampleCodeEntity api_example_code API 示例代码实体 ApiFlowControlEntity api_flow_control API 流控配置实体 ApiTestExampleEntity api_test_example API 测试示例实体 26.2 申请与审批实体 实体类建议 对应表建议 说明 ApiUseApplyEntity api_use_apply API 使用申请实体 ApiPublishApplyEntity api_publish_apply API 发布申请实体 ApprovalWorkorderEntity approval_workorder 审批工单实体 ApprovalRecordEntity approval_record 审批记录实体 ApprovalProcessEntity approval_process 审批流主表实体 ApprovalProcessNodeEntity approval_process_node 审批流节点实体 26.3 授权与访问控制实体 实体类建议 对应表建议 说明 ApiAuthGrantEntity api_auth_grant API 授权实体 ApiAccessControlEntity api_access_control API 访问控制实体 ApiTokenResetLogEntity api_token_reset_log token 重置日志实体 ApiAuthOperateLogEntity api_auth_operate_log 授权操作日志实体 26.4 日志、统计、运营实体 实体类建议 对应表建议 说明 ApiServiceCallLogEntity api_service_call_log 服务调用日志实体 ApiServiceChangeLogEntity api_service_change_log API 服务变更日志实体 ApiOperateLogEntity api_operate_log 接口操作日志实体 ApiStatDailyEntity api_stat_daily API 统计日报实体 UserApiStatDailyEntity user_api_stat_daily 用户 API 统计日报实体 ApiRecommendConfigEntity api_recommend_config API 推荐配置实体 MessageNoticeEntity message_notice 消息通知实体 FileRecordEntity file_record 文件记录实体 AppInfoEntity app_info 应用信息实体 27. Request 清单建议 建议所有请求对象放在 data/request 目录，命名采用 XXXRequest / XXXPageRequest 风格。

27.1 API 市场相关 Request 类名建议 用途 ApiMarketSearchPageRequest API 搜索分页查询 ApiMarketDetailRequest API 详情查询 ApiMarketViewRequest API 浏览量记录 ApiExampleCodeDownloadRequest 示例代码下载 ApiRecommendQueryRequest 推荐 API 查询 27.2 API 使用申请相关 Request 类名建议 用途 ApiUseApplySubmitRequest 提交 API 使用申请 ApiUseApplyUpdateRequest 编辑 API 使用申请 ApiUseApplyPageRequest API 使用申请分页查询 ApiUseApplyDetailRequest API 使用申请详情查询 ApiUseApplyWithdrawRequest 撤回 API 使用申请 27.3 我的 API 与发布申请相关 Request 类名建议 用途 MyApiSaveRequest 创建 API MyApiUpdateRequest 编辑 API MyApiPageRequest 我的 API 分页查询 MyApiDetailRequest 我的 API 详情查询 MyApiDeleteRequest 删除 API MyApiPublishRequest 提交发布申请 MyApiOfflineRequest 下线 API MyApiTestRequest API 测试 ApiPublishApplyPageRequest 发布申请分页查询 ApiPublishApplyDetailRequest 发布申请详情查询 ApiPublishApplyWithdrawRequest 撤回发布申请 27.4 审批相关 Request 类名建议 用途 ApprovalWorkorderPageRequest 审批工单分页查询 ApprovalWorkorderDetailRequest 审批工单详情查询 ApprovalPassRequest 审批通过 ApprovalRejectRequest 审批驳回 ApprovalRecordPageRequest 审批记录查询 ApprovalProcessPageRequest 审批流分页查询 ApprovalProcessSaveRequest 审批流保存 ApprovalProcessDetailRequest 审批流详情 ApprovalProcessStatusRequest 审批流启停 27.5 授权与访问控制相关 Request 类名建议 用途 ApiAuthGrantPageRequest 授权列表分页查询 ApiAuthGrantDetailRequest 授权详情查询 ApiAuthGrantResetTokenRequest 重置 token ApiAuthGrantReapplyRequest 重新申请授权 ApiAccessControlUpdateRequest 修改访问控制 ApiAccessControlStatusRequest 启用/停用访问权限 ApiAuthOperateLogPageRequest 授权操作日志分页查询 27.6 推荐、统计、日志、公共能力相关 Request 类名建议 用途 ApiRecommendPageRequest 推荐管理分页查询 ApiRecommendStatusRequest 推荐/取消推荐 ApiRecommendWeightRequest 修改权重 ApiStatTrendRequest API 调用趋势统计 ApiStatHealthRequest API 健康统计 ApiStatErrorRequest API 错误分布统计 ApiStatActivityRequest API 活跃度统计 UserApiStatRequest 用户活跃量统计 ApiServiceCallLogPageRequest 服务调用日志分页查询 ApiOperateLogPageRequest 操作日志分页查询 CategoryDictQueryRequest 分类字典查询 AppInfoPageRequest 应用列表查询 FileUploadRequest 文件上传 MessageNoticePageRequest 消息分页查询 MessageReadRequest 消息已读 28. VO 清单建议 建议所有返回对象放在 data/vo 目录，按业务用途拆分。

28.1 API 市场相关 VO 类名建议 用途 ApiMarketListVO API 搜索/列表展示对象 ApiMarketDetailVO API 详情对象 ApiHotVO 热门 API 展示对象 ApiLatestVO 最新 API 展示对象 ApiRecommendVO 推荐 API 展示对象 ApiCategoryVO API 分类对象 ApiExampleCodeVO 示例代码下载对象 ApiRequestParamVO 请求参数展示对象 ApiResponseParamVO 返回参数展示对象 ApiErrorCodeVO 错误码展示对象 ApiFlowControlVO 流控说明对象 28.2 申请与审批相关 VO 类名建议 用途 ApiUseApplyListVO 使用申请列表对象 ApiUseApplyDetailVO 使用申请详情对象 ApiPublishApplyListVO 发布申请列表对象 ApiPublishApplyDetailVO 发布申请详情对象 ApprovalWorkorderListVO 审批工单列表对象 ApprovalWorkorderDetailVO 审批工单详情对象 ApprovalRecordVO 审批记录对象 ApprovalProcessVO 审批流配置对象 ApprovalProcessNodeVO 审批流节点对象 28.3 我的 API 相关 VO 类名建议 用途 MyApiListVO 我的 API 列表对象 MyApiDetailVO 我的 API 详情对象 MyApiSaveResultVO API 保存结果对象 MyApiTestResultVO API 测试结果对象 28.4 授权与访问控制相关 VO 类名建议 用途 ApiAuthGrantListVO 授权列表对象 ApiAuthGrantDetailVO 授权详情对象 ApiTokenResetVO token 重置结果对象 ApiAccessControlVO 访问控制对象 ApiAuthOperateLogVO 授权操作日志对象 28.5 推荐、统计、日志、公共能力相关 VO 类名建议 用途 ApiRecommendListVO 推荐管理列表对象 ApiStatTrendVO API 趋势统计对象 ApiStatSummaryVO API 统计汇总对象 ApiActivityRankVO API 活跃度对象 UserApiActivityVO 用户活跃度对象 ApiServiceCallLogVO 服务调用日志对象 ApiOperateLogVO 操作日志对象 CategoryDictVO 分类字典对象 AppInfoVO 应用信息对象 FileUploadVO 文件上传结果对象 MessageNoticeVO 消息通知对象 29. Controller 与 Service 映射建议 Controller Service 主要说明 ApiMarketController IApiMarketService 门户查询与详情展示 ApiUseApplyController IApiUseApplyService 使用申请流程 ApiPublishApplyController IApiPublishApplyService 发布申请流程 MyApiController IMyApiService API 创建、编辑、发布、测试 ApprovalWorkorderController IApprovalWorkorderService 审批工单与审批动作 ApprovalProcessController IApprovalProcessService 审批流配置 ApiAuthGrantController IApiAuthGrantService 授权与 token 管理 ApiAccessControlController IApiAccessControlService 访问控制规则维护 ApiRecommendController IApiRecommendService 推荐运营 ApiStatController IApiStatService 统计分析 ApiLogController IApiLogService 日志查询 CommonSupportController ICommonSupportService 公共字典、文件、消息 30. 推荐优先落地的后端开发包顺序 30.1 第一批 ApiMarketController / IApiMarketService ApiUseApplyController / IApiUseApplyService ApprovalWorkorderController / IApprovalWorkorderService ApiAuthGrantController / IApiAuthGrantService 30.2 第二批 MyApiController / IMyApiService ApiPublishApplyController / IApiPublishApplyService ApiAccessControlController / IApiAccessControlService 30.3 第三批 ApiRecommendController / IApiRecommendService ApiStatController / IApiStatService ApiLogController / IApiLogService ApprovalProcessController / IApprovalProcessService 31. 下一步可继续细化的内容 如果继续往实施层推进，建议下一步输出：

每个 Controller 的接口方法清单 每个 Request / VO 的字段定义表 关键 Entity 字段明细与注解建议 状态枚举类与常量设计建议 32. Controller 接口方法清单 以下方法名建议遵循项目现有风格，可根据实际历史命名做兼容调整。

32.1 ApiMarketController 方法名建议 请求方式 路径 入参 返回 searchApiPage GET /api/market/api/search ApiMarketSearchPageRequest Page getApiPage GET /api/market/api/page ApiMarketSearchPageRequest Page getHotApiList GET /api/market/api/hot/list ApiRecommendQueryRequest List getLatestApiList GET /api/market/api/latest/list ApiRecommendQueryRequest List getRecommendApiList GET /api/market/api/recommend/list ApiRecommendQueryRequest List getApiCategoryList GET /api/market/api/category/list CategoryDictQueryRequest List getApiDetail GET /api/market/api/detail ApiMarketDetailRequest ApiMarketDetailVO addApiViewCount POST /api/market/api/view ApiMarketViewRequest Boolean downloadExampleCode GET /api/market/api/example/download ApiExampleCodeDownloadRequest File / ResponseEntity 32.2 ApiUseApplyController 方法名建议 请求方式 路径 入参 返回 submitUseApply POST /api/apply/use/submit ApiUseApplySubmitRequest ApiUseApplyDetailVO getUseApplyPage GET /api/apply/use/page ApiUseApplyPageRequest Page getUseApplyDetail GET /api/apply/use/detail ApiUseApplyDetailRequest ApiUseApplyDetailVO withdrawUseApply POST /api/apply/use/withdraw ApiUseApplyWithdrawRequest Boolean updateUseApply POST /api/apply/use/update ApiUseApplyUpdateRequest Boolean 32.3 ApiPublishApplyController 方法名建议 请求方式 路径 入参 返回 getPublishApplyPage GET /api/apply/publish/page ApiPublishApplyPageRequest Page getPublishApplyDetail GET /api/apply/publish/detail ApiPublishApplyDetailRequest ApiPublishApplyDetailVO withdrawPublishApply POST /api/provider/api/withdraw ApiPublishApplyWithdrawRequest Boolean 32.4 MyApiController 方法名建议 请求方式 路径 入参 返回 saveMyApi POST /api/provider/api/save MyApiSaveRequest MyApiSaveResultVO updateMyApi POST /api/provider/api/update MyApiUpdateRequest MyApiSaveResultVO getMyApiPage GET /api/provider/api/page MyApiPageRequest Page getMyApiDetail GET /api/provider/api/detail MyApiDetailRequest MyApiDetailVO deleteMyApi POST /api/provider/api/delete MyApiDeleteRequest Boolean publishMyApi POST /api/provider/api/publish MyApiPublishRequest ApiPublishApplyDetailVO offlineMyApi POST /api/provider/api/offline MyApiOfflineRequest Boolean testMyApi POST /api/provider/api/test MyApiTestRequest MyApiTestResultVO 32.5 ApprovalWorkorderController 方法名建议 请求方式 路径 入参 返回 getWorkorderPage GET /api/approval/workorder/page ApprovalWorkorderPageRequest Page getWorkorderDetail GET /api/approval/workorder/detail ApprovalWorkorderDetailRequest ApprovalWorkorderDetailVO passWorkorder POST /api/approval/workorder/pass ApprovalPassRequest Boolean rejectWorkorder POST /api/approval/workorder/reject ApprovalRejectRequest Boolean getApprovalRecordList GET /api/approval/record/list ApprovalRecordPageRequest List 32.6 ApprovalProcessController 方法名建议 请求方式 路径 入参 返回 getApprovalProcessPage GET /api/approval/process/page ApprovalProcessPageRequest Page getApprovalProcessDetail GET /api/approval/process/detail ApprovalProcessDetailRequest ApprovalProcessVO saveApprovalProcess POST /api/approval/process/save ApprovalProcessSaveRequest Boolean updateApprovalProcessStatus POST /api/approval/process/status ApprovalProcessStatusRequest Boolean 32.7 ApiAuthGrantController 方法名建议 请求方式 路径 入参 返回 getAuthGrantPage GET /api/auth/grant/page ApiAuthGrantPageRequest Page getAuthGrantDetail GET /api/auth/grant/detail ApiAuthGrantDetailRequest ApiAuthGrantDetailVO resetGrantToken POST /api/auth/grant/resetToken ApiAuthGrantResetTokenRequest ApiTokenResetVO reapplyGrant POST /api/auth/grant/reapply ApiAuthGrantReapplyRequest Boolean getAuthOperateLogPage GET /api/auth/operateLog/page ApiAuthOperateLogPageRequest Page 32.8 ApiAccessControlController 方法名建议 请求方式 路径 入参 返回 updateAccessControl POST /api/auth/access/update ApiAccessControlUpdateRequest ApiAccessControlVO updateAccessStatus POST /api/auth/access/status ApiAccessControlStatusRequest Boolean 32.9 ApiRecommendController 方法名建议 请求方式 路径 入参 返回 getRecommendManagePage GET /api/recommend/api/page ApiRecommendPageRequest Page updateRecommendStatus POST /api/recommend/api/status ApiRecommendStatusRequest Boolean updateRecommendWeight POST /api/recommend/api/weight ApiRecommendWeightRequest Boolean 32.10 ApiStatController 方法名建议 请求方式 路径 入参 返回 getApiTrendStat GET /api/stat/api/trend ApiStatTrendRequest ApiStatTrendVO getApiHealthStat GET /api/stat/api/health ApiStatHealthRequest ApiStatSummaryVO getApiErrorStat GET /api/stat/api/error ApiStatErrorRequest ApiStatSummaryVO getApiActivityStat GET /api/stat/api/activity ApiStatActivityRequest List getUserActivityStat GET /api/stat/user/activity UserApiStatRequest List getSlowApiTop GET /api/stat/api/slowTop ApiStatActivityRequest List 32.11 ApiLogController 方法名建议 请求方式 路径 入参 返回 getServiceCallLogPage GET /api/log/service/page ApiServiceCallLogPageRequest Page getOperateLogPage GET /api/log/operate/page ApiOperateLogPageRequest Page 32.12 CommonSupportController 方法名建议 请求方式 路径 入参 返回 getCategoryList GET /api/common/category/list CategoryDictQueryRequest List getAppPage GET /api/common/app/list AppInfoPageRequest Page uploadFile POST /api/common/file/upload FileUploadRequest FileUploadVO downloadFile GET /api/common/file/download ApiExampleCodeDownloadRequest File / ResponseEntity getMessagePage GET /api/common/message/page MessageNoticePageRequest Page readMessage POST /api/common/message/read MessageReadRequest Boolean 33. 核心 Request 字段定义表 33.1 ApiMarketSearchPageRequest 字段名 类型建议 必填 说明 keyword String 否 搜索关键词 searchType String 否 搜索类型：name/path/desc categoryId Long / String 否 分类 ID apiType String 否 API 类型 sortBy String 否 排序字段 sortOrder String 否 asc/desc current Integer 是 当前页 size Integer 是 每页条数 33.2 ApiUseApplySubmitRequest 字段名 类型建议 必填 说明 apiId Long / String 是 API ID appId Long / String 是 应用 ID applyReason String 是 申请理由 accessIpRange String 是 访问 IP 网段 flowStrategy String 是 流量策略说明 attachmentIds List / List 否 附件 ID 集合 33.3 MyApiSaveRequest 字段名 类型建议 必填 说明 apiName String 是 API 名称 apiIcon String 否 API 图标地址 apiDesc String 是 API 描述 apiType String 是 API 类型 categoryId Long / String 是 分类 ID publisherOrg String 是 发布机构 requestMethod String 是 请求方式 apiPath String 是 API 路径 visibleScope String 是 可见范围 responseFormat String 是 返回格式 techOwner String 是 技术负责人 contactInfo String 是 联系方式 designIdea String 否 创作思路 dataStructureDesc String 否 数据结构说明 useGuide String 否 使用方法 requestParams List 否 请求参数列表 responseParams List 否 返回参数列表 errorCodes List 否 错误码列表 flowControl MyApiFlowControlRequest 否 流控配置 testExamples List 否 测试示例 saveType String 是 保存类型：DRAFT/SUBMIT 33.4 ApprovalPassRequest 字段名 类型建议 必填 说明 workorderId Long / String 是 工单 ID approvalOpinion String 否 审批意见 33.5 ApprovalRejectRequest 字段名 类型建议 必填 说明 workorderId Long / String 是 工单 ID approvalOpinion String 否 审批意见 rejectReason String 是 驳回原因 33.6 ApiAuthGrantPageRequest 字段名 类型建议 必填 说明 keyword String 否 关键词，支持 API 名称 grantStatus String 否 授权状态 current Integer 是 当前页 size Integer 是 每页条数 33.7 ApiAccessControlUpdateRequest 字段名 类型建议 必填 说明 grantId Long / String 是 授权 ID enableStatus Integer 是 启用状态：1启用0停用 applyDeadline String / Date 否 授权期限 accessIpRange String 否 访问 IP 白名单 flowLimitRule String 否 流量控制规则 remark String 否 备注 33.8 ApiRecommendStatusRequest 字段名 类型建议 必填 说明 apiId Long / String 是 API ID recommendStatus Integer 是 推荐状态 recommendType String 否 推荐类型 33.9 ApiStatTrendRequest 字段名 类型建议 必填 说明 beginDate String 是 开始日期 endDate String 是 结束日期 categoryId Long / String 否 分类 ID apiId Long / String 否 API ID 33.10 ApiServiceCallLogPageRequest 字段名 类型建议 必填 说明 apiId Long / String 否 API ID appId Long / String 否 应用 ID resultCode String 否 调用结果码 beginTime String 否 开始时间 endTime String 否 结束时间 current Integer 是 当前页 size Integer 是 每页条数 34. 核心 VO 字段定义表 34.1 ApiMarketListVO 字段名 类型建议 说明 apiId Long / String API ID apiName String API 名称 apiIcon String API 图标 apiDesc String API 描述 apiType String API 类型 categoryId Long / String 分类 ID categoryName String 分类名称 requestMethod String 请求方式 apiPath String API 路径 score BigDecimal 评分 applyCount Integer / Long 申请次数 callCount Integer / Long 调用次数 viewCount Integer / Long 浏览次数 publishTime String / Date 发布时间 34.2 ApiMarketDetailVO 字段名 类型建议 说明 apiId Long / String API ID apiName String API 名称 apiIcon String API 图标 apiDesc String API 描述 apiType String API 类型 categoryId Long / String 分类 ID categoryName String 分类名称 publisherOrg String 发布机构 publishUserName String 发布人 techOwner String 技术负责人 contactInfo String 联系方式 requestMethod String 请求方式 apiPath String API 路径 visibleScope String 可见范围 responseFormat String 返回格式 score BigDecimal 评分 applyCount Integer / Long 申请次数 callCount Integer / Long 调用次数 viewCount Integer / Long 浏览次数 designIdea String 创作思路 dataStructureDesc String 数据结构说明 useGuide String 使用方法 requestParams List 请求参数 responseParams List 返回参数 errorCodes List 错误码列表 flowControl ApiFlowControlVO 流控说明 exampleCode ApiExampleCodeVO 示例代码 34.3 ApiUseApplyListVO 字段名 类型建议 说明 applyId Long / String 申请 ID applyNo String 申请编号 apiId Long / String API ID apiName String API 名称 appId Long / String 应用 ID appName String 应用名称 applyStatus String 申请状态 applyStatusName String 状态名称 currentApprovalNode String 当前审批节点 applyTime String / Date 申请时间 rejectReason String 驳回原因 34.4 MyApiListVO 字段名 类型建议 说明 apiId Long / String API ID apiName String API 名称 apiType String API 类型 categoryName String 分类名称 status String API 状态 statusName String 状态名称 createTime String / Date 创建时间 updateTime String / Date 更新时间 34.5 ApprovalWorkorderDetailVO 字段名 类型建议 说明 workorderId Long / String 工单 ID businessType String 业务类型 businessTypeName String 业务类型名称 businessId Long / String 业务 ID status String 工单状态 statusName String 状态名称 applicantId Long / String 申请人 ID applicantName String 申请人名称 submitTime String / Date 提交时间 currentNode String 当前审批节点 formData Object / Map<String,Object> 表单数据 approvalRecords List 审批记录 34.6 ApiAuthGrantDetailVO 字段名 类型建议 说明 grantId Long / String 授权 ID apiId Long / String API ID apiName String API 名称 appId Long / String 应用 ID appName String 应用名称 tokenValue String Token grantStatus String 授权状态 grantStatusName String 授权状态名称 effectiveTime String / Date 生效时间 expireTime String / Date 失效时间 enableStatus Integer 启用状态 enableStatusName String 启用状态名称 accessIpRange String 访问 IP flowLimitRule String 流量规则 operateLogs List 操作日志 34.7 ApiRecommendListVO 字段名 类型建议 说明 apiId Long / String API ID apiName String API 名称 apiType String API 类型 categoryName String 分类名称 recommendStatus Integer 推荐状态 recommendStatusName String 推荐状态名称 weightValue Integer 权重值 callCount Integer / Long 调用次数 applyCount Integer / Long 申请次数 34.8 ApiStatTrendVO 字段名 类型建议 说明 xAxis List 横轴日期 series List 趋势数据 summary ApiStatSummaryVO 汇总数据 34.9 ApiServiceCallLogVO 字段名 类型建议 说明 logId Long / String 日志 ID apiId Long / String API ID apiName String API 名称 appId Long / String 应用 ID appName String 应用名称 callerUserName String 调用人 requestTime String / Date 请求时间 responseTime String / Date 响应时间 durationMs Long 耗时 resultCode String 结果码 resultMsg String 结果说明 35. 嵌套对象定义建议 35.1 MyApiSaveRequest 嵌套对象 类名建议 关键字段 MyApiRequestParamItemRequest paramName、paramType、requiredFlag、defaultValue、exampleValue、paramDesc、sort MyApiResponseParamItemRequest fieldName、fieldType、fieldDesc、exampleValue、sort MyApiErrorCodeItemRequest errorCode、errorMsg、errorDesc、sort MyApiFlowControlRequest limitType、limitValue、timeUnit、status、remark MyApiTestExampleItemRequest exampleType、requestExample、responseExample 35.2 统计类 VO 嵌套对象 类名建议 关键字段 ApiStatSeriesVO name、data ApiStatSummaryVO totalCallCount、avgDailyCallCount、totalApplyCount、errorCount 36. 建议优先生成的代码骨架顺序 ApiMarketController + IApiMarketService + ApiMarketSearchPageRequest + ApiMarketListVO ApiUseApplyController + IApiUseApplyService + ApiUseApplySubmitRequest + ApiUseApplyListVO ApprovalWorkorderController + IApprovalWorkorderService + ApprovalPassRequest + ApprovalWorkorderDetailVO ApiAuthGrantController + IApiAuthGrantService + ApiAuthGrantPageRequest + ApiAuthGrantDetailVO MyApiController + IMyApiService + MyApiSaveRequest + MyApiDetailVO 37. 下一步建议 如果继续，我建议直接进入最后一层可执行设计：

关键 Entity 字段明细与注解建议 状态枚举类与常量设计建议 可直接复制到项目里的 Java 类骨架模板