是否可以为URI参数定义验证(范围,长度)?

时间:2015-03-23 07:43:23

标签: apiblueprint

是否可以为URI参数定义验证?

  • (即maxValminValmaxLength等?)

如果没有,是否有任何好的解决方法至少记录参数的有效范围?

1 个答案:

答案 0 :(得分:1)

目前没有专门的参数验证语法。支持的唯一属性是必需/可选和可能值的枚举。

我想说最好使用markdown格式的文本来记录任何进一步的约束。例如:

# Blog Posts [/posts{?limit}]
 ...    

## Retrieve Blog Posts [GET]
Retrieves the list of **ACME Blog** posts.

+ Parameters
    + limit (optional, number) 

        Maximum number of posts to retrieve. The limit **must** be a positive integer.


+ Response 200

有计划的语法,有利于进一步的“机器”处理,并且最有可能来自计划的MSON验证语法。