开启 API 资产发现规则开关后,可按输入的正则表达式,对具有相同业务含义的 API 调用进行发现归并,统一收敛为一个标准 API 资产。默认情况下系统以内置模型自动发现;当发现结果不符合预期(如路径中带动态参数的接口被拆散)时,可添加自定义规则修正发现方式,命中规则后下次资产更新将按最新结果展示并清理历史数据。API 资产发现规则无系统内置规则,需自行添加自定义规则。
添加自定义规则
开启 API 资产发现规则开关后,可以根据业务场景自定义 API 资产发现规则,修正 API 资产的发现方式。
说明:
默认不需设置,未自定义时按系统内置模型发现 API。
若发现结果不符合预期,可使用自定义发现规则修正;命中自定义规则后,下次资产更新会淘汰历史数据并按最新结果展示。
单个域名最多可以手动添加 20 条 API 资产发现规则。
1. 在 API 安全 > 规则配置 > API 资产发现规则页面,单击添加规则。
2. 在添加规则窗口中,配置以下参数,单击确定即可创建规则。
3. 添加规则后,可以编辑或删除对应的规则。
配置项说明
规则名称:支持自定义输入,不允许重复,最长 10 个字符。
API 名称:填写需要自定义发现的 API 资产路径。
请求方式:支持多选 GET、POST、PUT、DELETE 请求方式。
匹配内容:输入正则表达式进行匹配,最长 200 个字符。
规则开关:控制本条规则的启用或停用状态,默认为启用。
配置示例
配置场景:针对 API 资产列表中资产发现不符合预期的场景,可以通过规则配置进行修正。如配置符合匹配内容中输入的正则表达式
/test1/test2/page/[A-Za-z0-9]的 URL 统一发现为 API 资产/test/test/page。
配置效果:配置后,所有符合正则表达式的 URL 均发现为配置的 API 资产
/test1/test2/page,且清除不符合预期的历史数据。