我将NelmioApiDocBundle与 PHP 框架Symfony3一起用于REST API。我想在 /api/doc 页面中显示我的参数的描述。如果不手动添加参数,这可能吗?我想从输入/输出类中导入它。
这是我的文档的外观:
这是生成文档的控制器操作(/api/user/login)的我的@ApiDoc :
* @ApiDoc(
* section = "user",
* resource = true,
* description = "Checks the user credentials and returns an authentication & refresh token if they are correct",
* input = { "class" = "AppBundle\Libraries\Core\User\LoginRequest", "name" = "" },
* output = { "class" = "AppBundle\Libraries\Core\User\LoginResponse", "name" = "" },
* statusCodes = {
* 200 = "Returned when successful",
* 400 = "Returned when request syntax is incorrect",
* 404 = "Returned when the page is not found",
* 429 = "Returned when the client sent too many requests during a time period",
* 500 = "Returned when an internal server error occured",
* 501 = "Returned when an unavailable request method is user (GET, POST, DELETE, PUT, ...)",
* 503 = "Returned when the service is unavailable at the moment eg. due to maintenance or overload"
* },
*
* )
AppBundle\Libraries\Core\User\LoginRequest类:
class LoginRequest implements JsonSerializable
{
/**
* The username.
*
* @var string
*
* @Assert\NotBlank()
* @Assert\Type("string")
*/
public $username;
/**
* The password.
*
* @var string
*
* @Assert\NotBlank()
* @Assert\Type("string")
*/
public $password;
/**
* Defines whether or not to save the refresh token as cooke.
*
* @var bool
*
* @Assert\NotBlank()
* @Assert\Type("bool")
*/
public $rememberPassword;
public function getUsername()
{
return $this->username;
}
public function setUsername($username)
{
$this->username = $username;
}
public function getPassword()
{
return $this->password;
}
public function setPassword($password)
{
$this->password = $password;
}
public function getRememberPassword()
{
return $this->rememberPassword;
}
public function setRememberPassword($rememberPassword)
{
$this->rememberPassword = $rememberPassword;
}
public function jsonSerialize()
{
return [
'username' => $this->username,
'password' => $this->password,
'rememberPassword' => $this->rememberPassword
];
}
}
我想使用这个类的描述,例如。用户名:“用户名。”,密码:“密码。” 而对于 rememberPassword:“定义是否将刷新令牌保存为 Cooke。”。
谢谢您的帮助。
问候奥兰多