接口引擎
接口引擎是将平台的某些功能数据根据接口规则进行配置，生成完整的接口文档提供出来，供用户调用。
功能列表
功能表单
功能表单详细介绍
1、基本信息
| 字段名称 | 说明 |
|---|---|
| 服务名称 | 必填，选择提供接口的服务 |
| 服务编码 | 只读，选择服务名称时带入 |
| 接口名称 | 必填，接口名称中文 |
| 版本 | 必填，接口版本 |
| 接口编码 | 必填，接口编码是API调用时用到的【apiCode】 |
| 状态 | 接口状态，状态有启用、暂停，默认暂停状态 |
| 服务类型 | 接口服务类型，可选择，值有查询、写入、更新、删除，默认查询 |
| 构建方式 | 接口构建方式，可选择，值有零码配置、自定义，默认零码配置 |
| 身份验证 | 接口是否需要身份验证，可选择，值有需要、不需要，默认需要 |
| Service name | 构建方式为自定义时显示，并且必填 |
| 数据来源 | 接口数据来源，可选择，值有表、功能，默认表 |
| 数据实体 | 根据数据来源决定选择的数据是表实体还是功能实体 |
| 基础查询条件 | 查询条件，可以用系统变量进行拼接，以 and xxx 开头 |
| 排序条件 | 排序条件 |
| 返回数据条数 | 返回数据条数，默认1000 |
| 总调用次数 | 默认 0（次），根据调用次数累加 |
| 总成功次数 | 调用成功的次数，单位（次） |
| 成功率 | 调用的成功率，单位（%） |
| 白名单 | 如果白名单不为空，则只能白名单内IP可以访问，如果是空则所有IP均可以访问（黑名单除外），多个使用逗号分开 |
| 黑名单 | 黑名单内的IP任何时候全不允许访问（在白名单内也无效），多个使用逗号分开 |
| 使用场景 | 接口使用场景描述 |
| 异常报警邮箱 | 调用接口，异常发生时会发送邮件到本邮箱中（多个邮箱逗号分开） |
2、参数验证
| 字段名称 | 说明 |
|---|---|
| 非法字符验证 | 可选择，默认关闭，值为全局传入参数均需验证时，非法字符必填 |
| 非法字符 | “”;-!~@$%^/_><()[]{} |
| 非法短语验证 | 可选择，默认关闭，值为全局传入参数均需验证时，非法短语必填 |
| 非法短语 | or,and,like,delete,drop,select,update,table,view |
| 自定义验证 | 默认关闭，开启时，Service name必填 |
| Service name | 自定义验证开启时显示，并必填 |
| 验证服务说明 | |
| 验证规则解释 | 首先进行参数必填、类型和长度验证，失败返回其次进行非法字符和短语验证，失败返回【非必须】再次进行自定义验证，失败返回【非必须】 |
3、输入模型、输出模型子功能
输入模型是当前接口处的入参，比如传什么条件查询，这个条件输入的规则在这里维护
输出模型是当前接口返回的数据字段，可以指定返回字段，包含子集数据
4、日志管理
用户授权
通过导入外部用户按钮，给当期接口进行用户授权
调用日志
当前接口的调用日志
异常日志
当前接口异常日志
最后编辑: 呼丽华 文档更新时间: 2024-08-29 09:50 作者：呼丽华
