使用 Swagger2 和 Symfony3 检索 POST 参数


Retrieve POST param with Swagger2 & Symfony3

我正在使用Symfony3开发一个Web服务,我正在使用Swagger-PHP 2.0.6来记录它。

为了简单起见,这是我想要实现的目标:

/**
 * @SWG'Post(path="/user",
 *   tags={"user"},
 *   summary="Registers a new user",
 *   operationId="registerUserAction",
 *   produces={"application/json"},
 *   @SWG'Parameter(
 *     in="body",
 *     name="user",
 *     description="User to register",
 *     required=true,
 *     @SWG'Schema(ref="#/definitions/UserInput")
 *   ),
 *   @SWG'Response(
 *     response=200,
 *     description="User registered"
 *   ),
 *   @SWG'Response(
 *     response=400,
 *     description="Invalid input"
 *   )
 * )
 * @var UserInput $user
 * @return JsonResponse
 **/
public function registerUserAction(UserInput $user)
{
    // Do stuff with the user model
    return new JsonResponse();
}

我的路线定义如下:

postUser:
    path: /user
    defaults: { _controller: MyBundle:User:registerUser }
    methods: [POST]

现在这是我从Symfony收到的错误:

控制器 "MyBundle''Controller''UserController::registerUserAction()" 要求您为"$user"参数提供一个值(因为 没有默认值或因为存在非可选参数 在这之后)。(500 内部服务器错误)

解决方法是将 Request 对象传递给控制器,然后直接从 $request->request 获取值,但这不是我在这里要实现的目标。

所以问题是,有什么办法可以实现这一目标吗?我记得我以前曾经在带有Swagger 1.x的Symfony2应用程序上这样做过。

PS:我也在使用招摇的用户界面

对于那些感兴趣的人,我设法使用自定义的 ParamConverter :) 使其工作