API 动态配置

API 动态配置模块允许你在运行时控制 API 接口的行为，无需修改代码或重启服务即可调整接口响应策略。

功能入口

登录管理后台后，点击左侧菜单 系统管理 > API 配置，进入接口配置列表页面。

核心能力

Forge Admin 通过 forge-starter-api-config 模块提供以下运行时配置能力：

接口行为开关

控制特定 API 接口的可用性，适用于紧急关闭风险接口、灰度发布等场景：

1. 在 API 配置页面，点击 新增 按钮
2. 填写配置项：
   • 接口路径：目标 API 路径，如 /system/user
   • 请求方式：GET / POST / PUT / DELETE / ALL
   • 开关状态：开启 / 关闭
   • 关闭提示：接口关闭时返回的错误信息
3. 点击 确定 保存
4. 配置立即生效，被关闭的接口会返回统一的错误响应

响应格式配置

部分接口支持配置返回数据的格式和内容：

• 字段脱敏：控制敏感字段的脱敏级别（如手机号显示 138****5678）
• 精简模式：选择是否返回全部字段或仅核心字段
• 分页大小：限制单次分页查询的最大返回条数

配置操作

新增配置

1. 点击 新增 按钮
2. 填写接口路径、请求方式、开关状态等信息
3. 保存后立即生效

编辑配置

1. 点击配置项操作列的 编辑 链接
2. 修改配置值
3. 保存后新配置即时生效

删除配置

1. 点击配置项操作列的 删除 链接
2. 确认后配置被移除，接口恢复默认行为

使用场景

• 紧急下架：发现接口安全漏洞，立即关闭接口
• 灰度控制：逐步开放新功能 API
• 限流保护：调整接口分页大小防止数据过量请求
• 合规脱敏：调整敏感信息返回策略

注意事项

• 接口开关为运行时配置，服务重启后保持
• 被关闭的接口返回统一错误格式：{"success": false, "message": "配置的关闭提示"}
• 建议在非高峰期进行接口配置变更

相关文档

• 动态配置管理 — 系统级参数配置