Swagger параметр запроса без знака вопроса

Question

Я использую Swagger , чтобы задокументировать мой api-rest, и я обнаружил проблему, которую не могу исправить. Когда я начинаю документировать свои API, я создаю эти комментарии перед функцией:

/**
 * @OA\Get(
 *     path="/api/my-route/",
 *     tags={"My-tag1","My-tag2"},
 *     description="Get data from user profile",
 *     @OA\Parameter(
 *          name="name_parameter",
 *          in="query",
 *          description="description parameter",
 *          required=true,
 *     ),
 *     @OA\Response(response="200", description="Data from user profile"),
 *     security={ {"api_key": {}} }
 * )
 */

Код генерирует хорошую документацию, но ... Когда я go для проверки маршрута, я обнаружил мою проблему:

http://127.0.0.1: 8000 / api / my-route /? Name_parameter = значение

Как установить параметр без знака вопроса?

Примерно так:

http://127.0.0.1: 8000 / api / my-route / value

Answer 1

Вы должны использовать:

in="path"

и изменить свой путь:

path="/api/my-route/{name_parameter}"

Вы можете найти больше информации здесь: https://swagger.io/docs/specification/describing-parameters/#path -параметры