API治理自定义规则开发：如何检查RAML中的trait？

你的需求完全可以实现，下面是具体的解决方法：

问题根源 #

你之前的规则配置没生效，是因为找错了Endpoint关联trait的属性——RAML里的is:标签对应AMF模型里的traits属性，而非你用的apiContract.ParameterizedTrait。

正确规则配置 #

直接用下面的规则就能实现检查每个资源是否包含secured trait的需求：

secured-trait-required:
  message: "每个资源必须包含`secured` trait"
  targetClass: apiContract.EndPoint
  propertyConstraints:
    traits:
      minCount: 1
      propertyConstraints:
        name:
          pattern: "^secured$"

配置说明 #

• targetClass: apiContract.EndPoint：指定规则作用在RAML的资源（Endpoint）上
• traits：对应RAML中的is:标签，用来获取资源绑定的所有trait列表
• minCount: 1：强制要求至少有一个符合名称匹配的trait
• name: {pattern: "^secured$"}：精确匹配trait名称为secured，正则的^和$避免出现类似secured-v2这种部分匹配的情况

验证效果 #

当某个RAML资源的is:列表里没有secured时，规则会触发你设置的错误提示。

内容的提问来源于stack exchange，提问作者Alastair