php – Nelmio Api Doc Bundle：记录所需的参数

2024年2月4日 220次阅读

我目前正在使用NelmioApiDocBundle,我还不熟悉它.我写的API必须提供一个更改特定用户密码的路径.文档应说明,更改密码既需要旧密码,也需要新密码.由于我没有找到需求和参数之间差异的解释,我想第一个用于路由数据,后者用于API调用本身.

首次尝试提供这样的文档是为了实现一个简单的模型,然后JMSSerializerBundle自动转换：

class ChangePasswordParam
{
    /**
     * @Type("string")
     * @var string
     */
    protected $oldPassword;

    /**
     * @Type("string")
     * @var string
     */
    protected $newPassword;

}

Controller通过此操作方法接受API调用：

/**
 * Changes the password for a specific user.
 *
 * @Post("/{username}/changepassword")
 * @View()
 * @ApiDoc(
 *  description="Changes the password of a User",
 *  input="FQCN\ChangePasswordParam"
 * )
 *
 * @param string              $username
 * @param ChangePasswordParam $passwordParam
 *
 * @return Response
 */
public function changePasswordAction($username, ChangePasswordParam $passwordParam)
{
    /* ... */
}

这导致文档显示用户名为Requirement,old_password和new_password作为参数.为了根据需要标记这些参数,我通过注释向属性添加了一个Symfony Constraint：

class ChangePasswordParam
{
    /**
     * @Type("string")
     * @Assert\NotNull()
     * @var string
     */
    protected $oldPassword;

    /**
     * @Type("string")
     * @Assert\NotNull()
     * @var string
     */
    protected $newPassword;

}

但是,虽然使用这些注释标记了所需的属性,但它确实会生成奇怪的输出：

《php – Nelmio Api Doc Bundle：记录所需的参数》

注意参数被添加两次并以不同的格式？添加@SerializedName(“old_password”)无效.关于this ticket,问题仍未解决.

接受动作数据的另一种方法是使用自定义表单,它确实根据需要标记属性,但也不生成正确的输出.将ChangePasswordParam更改为自定义表单：

class ChangePasswordParam extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('old_password', 'text');
        $builder->add('new_password', 'text');
    }


    /**
     * Returns the name of this type.
     *
     * @return string The name of this type
     */
    public function getName()
    {
        return 'change_password';
    }

}

导致此参数说明：
《php – Nelmio Api Doc Bundle：记录所需的参数》

这些参数应该只命名为’old_password’和’new_password’,我无法弄清楚如何实现这一点.

提前致谢

最佳答案 您的@ApiDoc注释应包含一个空的输入表单名称字段,如下所示：

* @ApiDoc(
*  description="Changes the password of a User",
*  input= {
*    "class" = "FQCN\ChangePasswordParam",
*    "name" = ""
*  }
* )

这将删除参数名称前的表单名称.

点赞