Можно ли определить валидации (диапазоны, длины) для параметров URI?

Question

Можно ли определить валидации для параметров URI?

• (т.е. maxVal, minVal, maxLength и т.д.?)

Если нет, есть ли хороший обходной путь, по крайней мере, документировании допустимый диапазон параметра, в?

Answer 1

В настоящий момент нет специального синтаксиса для проверки параметров. Требуются только поддерживаемые атрибуты/необязательные и перечисление возможных значений.

Я бы сказал, что лучше всего использовать текст с отформатированным отпечатком для документирования любых дальнейших ограничений. Например:

# 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.