欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

yaml文件使用参数校验

程序员文章站 2023-12-30 17:22:34
...

1、 现阶段只支持请求body内的简单数据类型参数值的校验,暂不支持path、query参数的校验。
2、 包括类型:int类型的最大最小值,string类型的最大长度最小长度、及正则表达式。
参数校验的相关配置值:

StudentInfo:
    properties:
        id:
            type: interger
            format: int32
            minimum: 10
            maximum: 20
            default: 10
            x-message: 'The value must be not more than {max}.'
        name:
            type: string
            minLength: 4
            maxLength: 10
            pattern: '^[A-Za-z]+$'
            x-message: 'The value must be match the pattern.'
 StudentsInfo:
     description: 'Response with list string values'
     properties:
         entity:
             type: array
             items:
                 $ref: '#/definitions/StudentInfo'

(1)int类型的最大最小值:
如上id值,其添加了三个关键字:minimum、maximum、x-message,其minimum表示id的最大值为20,其maximum表示最小值为10,而x-message表示生成的默认出错返回信息为x-message的内容:The value must be not more than {max}.
(2)string类型的最大长度最小长度:
如上name值,其添加了关键字:minLength、maxLength,minLength表示最小长度为4,maxLength最大长度为10.
(3)string类型的正则表达式:
如上name值,除了(2)所添加的关键字外,还添加了关键字:pattern,其表示传入的string值必须满足一定条件格式,才会调通接口,否则返回校验出错信息;

相关标签: yaml

上一篇:

下一篇: