Swagger аннотация для параметров запроса - PullRequest
Новая
       22

Swagger аннотация для параметров запроса

1 голос
/ 06 ноября 2019

Я преобразую запрос POST в запрос GET. Я использую NelmioApiDocBundle для документирования своих конечных точек API. В настоящее время у меня есть следующая (старая) аннотация: 

/**
 * @SWG\Response(
 *     response=200,
 *     description="Success - return JSON",
 * )
 * @SWG\Tag(name="Open Vacancies")
 *
 * @SWG\Parameter(
 *     name="Message body",
 *     in="body",
 *     type="string",
 *     description="JSON string specifying a page number and page size",
 *     required=true,
 *     @SWG\Schema(
 *         type="object",
 *         @SWG\Property(property="page", type="integer"),
 *         @SWG\Property(property="pageSize", type="integer")
 *     )
 * )
 *
 * @Route("/open-vacancies", methods={"POST"}, defaults={"_format": "json"}, name="api.open_vacancies")
 */

Теперь я хочу, чтобы разработчики могли вызывать мою конечную точку с URL-адресом типа https://myapi.myapp.com/open-vacancies?page=1&pageSize=10. Но я не знаю, как определить документацию в форме аннотации. Google не сильно мне помог. Может ли кто-нибудь указать мне соответствующую документацию для этого (или, в случае неудачи, ввести пример аннотации, которую я мог бы использовать)?

1 Ответ

2 голосов
/ 06 ноября 2019

Для документирования параметра запроса вы также можете использовать аннотацию @SWG\Parameter, но вы установите значение in в query вместо body

Пример: 

/**
 * @SWG\Parameter(
 *     name="pageSize",
 *     in="query",
 *     type="string",
 *     description="Description goes here"
 * )
 */
...