API 管理

✦ 开放接口

动态 API 管理平台，通过可视化配置即可创建 REST API 接口，无需编写代码就能对外暴露数据服务，支持参数配置、权限控制、数据映射。

⚙️

动态 API 创建

可视化配置 API 端点、请求方法、参数定义，运行时动态解析执行，无需编码和部署。

🔐

权限控制

精细化 API 权限管理，支持基于角色和用户的访问控制，接口调用需鉴权认证。

📋

参数映射

灵活的参数定义与数据映射，支持输入参数校验、输出字段筛选、数据格式转换。

📄

在线调试

内置 API 调试工具，可视化构造请求、查看响应，快速验证接口的正确性。

核心概念

概念	说明
API 定义（SysApi）	接口的基本信息，包括名称、路径、请求方法、描述等
参数定义（SysApiParam）	请求参数配置，支持路径参数、查询参数、请求体参数
表绑定（SysApiTable）	API 与数据表的关联配置，指定 CRUD 操作目标
列映射（SysApiColumn）	数据表字段与 API 返回字段的映射关系
权限配置（SysApiPermission）	接口访问权限定义，控制哪些角色/用户可访问

功能说明

创建 API

在「API 管理」模块中，通过表单配置即可创建一个完整的 REST API。支持的配置项包括：

基本信息： API 名称、请求路径（如 /api/dynamic/orders）、请求方法（GET/POST/PUT/DELETE）。
参数定义： 请求参数名称、类型、是否必填、默认值、校验规则。
数据映射： 绑定目标数据表，配置字段映射关系，支持字段别名、类型转换。
权限设置： 可选是否需要认证、允许的角色列表、IP 白名单。

请求处理流程

客户端发起 API 请求到 APIController 入口端点
系统根据请求路径匹配已注册的动态 API 定义
校验请求参数合法性，解析参数值
执行权限检查，验证调用方是否有访问权限
根据 API 绑定的数据表配置，动态生成 SQL 并执行
按照列映射配置组装响应数据，返回 JSON 格式结果

安全机制

API 管理模块提供多层安全防护：

认证鉴权： 支持 JWT Token 认证，接口可配置是否需要登录才能访问。
权限控制： 细粒度角色-权限模型，控制不同角色的接口访问范围。
参数校验： 自动校验请求参数类型、格式、长度，防止 SQL 注入。
频率限制： 可配置接口调用频率限制，防止滥用。
审计日志： 所有 API 调用记录操作日志，便于追踪和审计。

快速开始

进入「API 管理 > API 定义」，点击新增 API
填写 API 名称、路径、选择请求方法
配置请求参数（路径参数 / 查询参数 / 请求体）
绑定目标数据表，配置字段映射关系
设置访问权限和认证方式
保存后在「调试」页面测试接口

配置示例

创建一个查询客户列表的 API：

// API 定义示例
{
  "name": "查询客户列表",
  "path": "/api/dynamic/customers",
  "method": "GET",
  "params": [
    { "name": "page", "type": "integer", "required": false, "default": "1" },
    { "name": "size", "type": "integer", "required": false, "default": "20" }
  ],
  "tableBinding": {
    "tableName": "biz_customer",
    "operation": "SELECT"
  }
}