Установите аннотацию «параметры» в NelmioApiDocBundle

Я создаю API RESTfull, используя Symfony2.1 с FOSRESTBundle, и я использую NelmioApiDocBundle для создания автоматической документации.

У меня есть запрос PUT, в котором пользователь должен отправить один параметр, но мне не нужно создавать форму для этой цели. Все работает отлично, но когда я генерирую документацию, я не знаю, как добавить этот параметр в документацию, потому что у меня нет формы ввода.

Я пробовал это, но, похоже, не работает:

 /**
 * @ApiDoc(
 *  description="description",
 *  statusCodes={
 *         200="Success",
 *         400="Bad request"},
 *  parameters={
 *         {"name"="parameter_name", "dataType"="integer"}
 *  }
 * )
 ...

В документации NelmioApiDocBundle я не нашел решения для этого...


person Fernando P. G.    schedule 01.02.2013    source источник


Ответы (1)


использовать ключ filter вместо параметров

 * filters={
 *     {"name"="parameter_name", "dataType"="integer"},
 * },
person Maciej Pyszyński    schedule 01.02.2013
comment
Да, я использую это сейчас, но фильтры - это не то же самое, что параметры... Есть ли возможность использовать параметры? Спасибо!!! - person Fernando P. G.; 01.02.2013