Пасека: есть ли способ определить параметры для параметров?
Я хотел бы определить параметры для параметров пасеки, в настоящее время я перечисляю их в описании:
- измерение =
m
(необязательно, строка,m
)... измерение, например, м = метры, км = километры, ярды = ярды, ми = мили
2 ответа
Решение
Вы можете перечислить возможные значения параметра запроса URI и обсудить его в обсуждении параметра следующим образом:
+ Parameters
+ measurement = `m` (optional, string) ... measurement units
Any discussion here...
e.g. explanation of **values** listed bellow are.
+ Values
+ `m`
+ `mi`
+ `yd`
Также см. Параметры запроса Документирование с помощью API Blueprint.
Вы можете определить дополнительные параметры в конечной точке, как показано ниже:
/api/data{?measurement}