顯示實體屬性描述的注釋-使用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