没有问号的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": {}} }
 * )
 */

代码生成了很好的文档，但是...当我去测试路线时，我发现了我的问题：

http://127.0.0.1:8000/api/my-route/?name_parameter=value

如何设置不带问号的参数？

像这样：

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-parameters

没有问号的swagger参数查询

Swagger parameter query without question mark

documentation

parameters

rest

laravel

swagger