在APIwiz API校验工作室中创建高级规则

作者:xiaoxin.gao · 2025-06-24 · 阅读时间:3分钟

在本文中,我们将了解如何使用正则表达式(Regex)模式、从内置模板导入规则以及基于高级函数创建规则,来创建校验规则。让我们看看如何使用正则表达式和函数定义更多规则。


使用正则表达式创建规则

  1. 创建新规则

    • 点击“添加”按钮,选择“新建规则”。
    • 输入规则的基本信息。例如,可以将其分类为“警告”。
    • 指定要校验的路径。例如,如果你想校验info.version字段,可以将路径设置为info.version
  2. 定义正则表达式

    • 在指定路径后,需要定义一个正则表达式,以匹配所需的格式。例如,如果你想让版本号遵循特定的格式(如1.0.0),可以添加一个正则表达式来确保这一点。
    • 对正则表达式满意后,点击“保存”。你的规则将成功创建。
  3. 查看和编辑规则

    • 你可以在“警告”标签中查看已创建的规则。
    • 要编辑规则,可以点击编辑按钮。你也可以复制规则,以快速创建一个略有修改的新规则。

从内置模板导入规则

  1. 导入规则

    • 点击“添加”按钮,选择“导入选项”。
    • 从可用的模板中进行选择。例如,你可以从“Spectral V3”模板导入规则。
    • 模板会显示它包含的所有规则列表。你可以取消选择某些规则,如果你不想导入它们全部。
    • 选择你想要的规则后,点击“添加”。所选规则将自动添加到你的规则集中。

使用高级函数创建规则

  1. 选择函数类型

    • 转到“函数”部分,选择“函数”类型。
    • 你会看到一系列预选规则。例如,如果你想为description字段创建规则,可以选择“描述不应重复”。
    • 这将自动填充对象路径,并默认提供规则的名称和描述。
  2. 选择不同函数

    • 你可以选择不同类型的函数,例如“路径”函数。例如,你可以创建一个规则,以确保路径不模糊或路径中不含动词。
    • 选择函数后,点击“保存”,将其添加到你的规则集中。

总结

在本指南中,我们介绍了如何创建不同类型规则、从现有模板导入规则以及使用函数更高效地创建规则。在下一个视频中,我们将看到如何将这些规则分配给OpenAPI规范,并查看校验结果。

原文引自:YouTube视频:https://www.youtube.com/watch?v=ZCgaARW4rOA