显示实体的属性描述的注释 - 使用nelmioapidocbundle

Question

我正在使用nelmioapidocbundle来记录构建在symfony-2.x之上的Rest API。

我无法找到正确的注释用于在返回部分显示每个实体的属性说明（请参阅下面附图）。

我的实体：

/**
 * 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)
    {}

结果（描述列为空）：

Answer 1

该软件包的doc部分有一个描述：

  

对于使用JMS元数据解析的类，将从属性doc注释中获取描述（如果可用）。   对于表单类型，您可以在每个表单上添加一个名为description的额外选项   字段

请访问以下链接以获取更多说明（本节底部的信息）：

https://github.com/nelmio/NelmioApiDocBundle/blob/master/Resources/doc/index.md#the-apidoc-annotation