选择的名字
编辑本页选择的名字
NelmioApiDoc自动生成模型名称,但是nelmio_api_doc.models.names
选项允许自定义某些型号的名称。
配置
您可以为每个组和区域组合定义替代名称:当出现冲突时,将使用最后一个匹配规则:
1 2 3 4 5 6 7
nelmio_api_doc:模型:的名字:-{别名:MainUser,类型:应用\ \用户实体}-{别名:MainUser_light,类型:应用实体\ \用户,组:(光)}-{别名:MainUser_secret,类型:应用实体\ \用户,领域:(私人)}-{别名:MainUser,类型:应用实体\ \用户,组:(标准),领域:(私人)}
在本例中是类应用实体\ \用户
将被别名化为:
MainUser
当没有指定更详细的规则时MainUser_light
当这个基团等于光
MainUser_secret
为私人
区域MainUser
为私人
当群等于标准
提示
这允许使用普通引用而不是@ model
.值得注意的是,你可以在配置中指定一个模型使用的组,然后引用它的替代名称:
1 2 3
nelmio_api_doc:模型:的名字:[{别名:MyModel,类型:App \ MyModel,组:(光)})
1 2 3 4 5 6 7 8 9
类HomeController{/ * * *@OA\反应(响应= 200,@OA\ JsonContent (ref = " # /组件/模式/ MyModel”))* /公共函数indexAction(){}}
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。