Документирование параметров POST с WADL
Смотря на текущую версию предложения WADL, я не мог вполне выяснить, как зарегистрировать параметры запроса POST (с application/x-www-form-urlencoded кодирование).
Я видел что-то вроде этого в дикой природе:
Однако для a используемый в качестве ребенка
Указывает параметр запроса URI, представленный согласно правилам для типа среды компонента запроса, указанного атрибутом queryType.
"Бит" запроса URI отбросил меня с тех пор мне, он предлагает параметры, добавляемые URI вместо того, чтобы быть включенным в тело.
С другой стороны, для a используемый в качестве ребенка
Указывает компонент представления как пара значение-имя, отформатированная согласно правилам типа среды. Обычно используемый с типом среды 'application/x-www-form-urlencoded' или 'multipart/form-data'.
Сделайте я должен использовать a
Это похоже на излишество. Я предполагаю, что должен смочь использовать первого, даже при том, что спецификация упоминает "запрос URI".
1 ответ
Теперь я вижу, что на самом деле мне следует использовать последнюю форму. Даже если это выглядит излишеством для простого документирования некоторых параметров POST, лучше явно документировать тот факт, что параметры являются частью тела == представления.
Правка от третьего лица
Последнее, вероятно, означает вот это
<resource path="/path1">
<method name="POST">
<request>
<representation mediaType="application/x-www-form-urlencoded">
<name="param1" style="query"/>
</representation>
</request>
</method>
</resource>