Symfony 注释以显示实体';s属性描述-使用nelmioapidocbundle
我使用nelmioapidocbundle来记录构建在symfony-2.x之上的restapi 我找不到用于在返回部分显示每个实体的属性描述的正确注释(请参见下面的附图) 我的实体:Symfony 注释以显示实体';s属性描述-使用nelmioapidocbundle,symfony,serialization,annotations,entity,Symfony,Serialization,Annotations,Entity,我使用nelmioapidocbundle来记录构建在symfony-2.x之上的restapi 我找不到用于在返回部分显示每个实体的属性描述的正确注释(请参见下面的附图) 我的实体: /** * Checkins * * @ORM\Table(name="CheckIns") * @ORM\Entity(repositoryClass="Project1\ApiBundle\Entity\CheckinsRepository") * * @ExclusionPolicy("none
/**
* Checkins
*
* @ORM\Table(name="CheckIns")
* @ORM\Entity(repositoryClass="Project1\ApiBundle\Entity\CheckinsRepository")
*
* @ExclusionPolicy("none")
*/
class Checkins
{
/**
* @var integer
*
* @ORM\Column(name="id", type="bigint", nullable=false)
* @ORM\Id
* @ORM\GeneratedValue(strategy="IDENTITY")
*
* @Groups({"checkin"})
* @
*/
private $id;
我的控制器:
class CheckinController extends BaseRestController
{
/**
* @ApiDoc(
* resource=true,
* description="Find checkin by ID",
*
* parameters={
* {"name"="categoryId", "dataType"="integer", "required"=true, "description"="checkin id"}
* }
*
* output={
* "class"="Project1\ApiBundle\Entity\Checkins",
* "groups"={"checkin"}
* },
* statusCodes={
* 200="Checkin found",
* 400="ID is required",
* 404="Checkin not found"
* }
* )
*
* @Rest\View()
*/
public function getAction(Request $request)
{}
结果(说明列为空):
捆绑包的文档部分有一个描述: 对于使用JMS元数据解析的类,描述将取自properties文档注释(如果可用)。 对于表单类型,可以在每个表单上添加一个名为description的额外选项 场 请访问以下链接了解更多说明(信息位于本节底部):