Квадратные скобки в имени параметра

Question

Мне было интересно, можно ли включать квадратные скобки в имя параметра, как это делают параметры групп Rails. Например:

+ Parameters 
     + person[age] (string) ... Person's age 

Прямо сейчас, если я включаю квадратную скобку, параметр не отображается.

Спасибо!

Answer 1

Технически квадратные скобки не допускаются в URI, кроме Internet Protocol Literal Address

RFC3513:

Хост идентифицируется с помощью Интернет-протокола буквального адреса, версия 6 [RFC3513] или более поздней версии, отличается ограждающих литерал IP в квадратных скобках («[» и «]»). Это единственное место, где символы квадратной скобки допускаются в синтаксисе URI.

Это означает, что квадратная скобка НЕ ​​ДОЛЖНА использоваться (неэкранирована) в имени параметра.

Решение в настоящее время заключается в том, чтобы избежать скобок вручную.

В будущем API Blueprint может автоматически избежать опасных символов для вас. См:

• Report square brackets in URI templates
• Escape Unsafe Characters in URI Templates