我正在将 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")
*/
现在我希望开发人员能够使用类似 https://myapi.myapp.com/open-vacancies?page=1&pageSize=10 的 url 调用我的端点。但是我不知道如何以注释形式定义文档。谷歌并没有帮助我太多。有人可以向我指出相关文档吗(或者，如果做不到，请输入我可以使用的注释示例)？
最佳答案
要记录查询参数，您还可以使用 @SWG\Parameter 注释，但您将 in 的值设置为 query而不是 body
示例:
/**
* @SWG\Parameter(
* name="pageSize",
* in="query",
* type="string",
* description="Description goes here"
* )
*/
关于php - 查询参数的 Swagger 注释，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/58734368/