其他Bundle注释
编辑本页警告:您正在浏览版本文档欧宝官网下载app2.倍它不再被维护了。
如果您的一些项目仍在使用此版本,请考虑升级。
其他Bundle注释
这个包将从以下其他注释中获取信息:
@FOS
-用作\ RestBundle \控制器 \注释 \ RequestParam 参数
@FOS
-用作\ RestBundle \控制器 \注释 \ QueryParam 需求
(当strict参数为true时),过滤器
(当strict为false时)@JMS \ SecurityExtraBundle \注释\安全
——设置身份验证
为真,authenticationRoles
到给定的角色@Sensio
——设置\包 \ FrameworkExtraBundle \配置 \缓存 缓存
PHPDoc
标记为@deprecated
将在界面中这样标记。
JMS序列化器特性
该包支持一些JMS Serializer特性,并在生成的文档中使用这一额外信息。欧宝官网下载app
群体排斥策略
如果你的类使用JMS组排除策略,你可以使用下面的语法来指定生成文档时使用的组:欧宝官网下载app
1 2 3 4
输入= {“类”=“Acme \包\实体\用户”,“组织”= {“更新”,“公共”}}
在这里是基团更新
而且公共
使用。此特性也适用于输出
财产。
版本控制对象
如果你的输出
类使用JMS Serializer的版本控制功能时,生成文档时将自动使用版本控制信息。欧宝官网下载app
表单类型及功能
即使你使用FormFactoryInterface:: createNamed(”、“your_form_type”)
文档将生欧宝官网下载app成表单类型名称作为输入的前缀(your_form_type(参数)
...而不仅仅是参数
).
属性指定要使用的前缀的名字
输入输入
部分:
1 2 3 4
输入= {“类”=“your_form_type”,“名称”=”“}
您还可以添加一些选项来传递给表单。你只需要使用选项
关键:
1 2 3 4
输入= {“类”=“your_form_type”,“选项”= {“方法”=“把”}},
使用自己的注解
如果您已经开发了自己的与项目相关的注释,并且希望解析它们以填充ApiDoc
,您可以将自定义处理程序作为服务提供。你只需要实现Nelmio \ ApiDocBundle \器\ HandlerInterface
并将其标记为nelmio_api_doc.extractor.handler
:
1 2 3 4 5 6
# app / config / config.yml服务:mybundle.api_doc.extractor.my_annotation_handler:类:MyBundle \ AnnotationHandler \ MyAnnotationHandler标签:-{名称:nelmio_api_doc.extractor.handler}
看看内置的处理程序.
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。