我可以使用Swagger指示参数值的正则表达式要求吗?

时间:2015-11-13 19:26:35

标签: swagger

在我的REST API中,其中一个提交的参数值必须是正则表达式后面的代码:

/[A-Z]{2}[0-9]{4}/

除了将它放在参数的description属性中之外,还有什么方法可以指示如果该值与我的正则表达式不匹配则该值无效吗?

我无法在Swagger文档中找到任何关于正则表达式的提及,除了作为识别图案化字段的方法(这不是我想要做的)。

1 个答案:

答案 0 :(得分:14)

您可以在api的参数中使用名为pattern的字段(如果不是正文)或属性的方案定义,它使用标准ECMA 262:(http://json-schema.org/latest/json-schema-validation.html#rfc.section.3.3