![](/img/trans.png)
[英]Symfony - NelmioApiDocBundle: Show parameter description imported from class
[英]Annotation to show Entity's property description - using nelmioapidocbundle
我正在使用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)
{}
结果(“描述”列为空):
捆绑软件的doc部分中有一个描述:
对于使用JMS元数据解析的类,将从属性doc注释(如果有)中进行描述。 对于表单类型,您可以在每个字段上添加一个名为description的附加选项。
请访问以下链接以获取更多说明(本节底部的信息):
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.