区域
编辑该页面区域
我们已经看到,您可以配置路线记录使用nelmio_api_doc.areas
:
1 2 3 4 5
nelmio_api_doc:领域:path_patterns:(^ / api]host_patterns:(^ \ api。]name_patterns:(^ api_v1]
但事实上,这个配置选项更强大的方式,允许你把你的文档在几个部分。欧宝官网下载app
配置
您可以定义区域将每个生成一个不同的文档:欧宝官网下载app
1 2 3 4 5 6 7 8 9 10 11 12
nelmio_api_doc:领域:默认值:path_patterns:(^ / api]host_patterns:(^ \ api。]内部:path_patterns:(^ /内部]商业:path_patterns:(^ /商业]存储:#包括路线名称包含“商店”name_patterns:(商店]
你的主要文档的欧宝官网下载app默认的
区域。这是一个显示当访问/ api /医生
。
然后更新路由能够访问你的不同的文件:欧宝官网下载app
1 2 3 4 5 6 7 8 9 10 11
# app / config / routing.yamlapp.swagger_ui:路径:/ api / doc /{区域}方法:得到默认值:{_controller:nelmio_api_doc.controller.swagger_ui,面积:默认的}#让他们为JSON# app.swagger.areas:#路径:/ api / doc /{区域}. json#的方法:#默认值:{_controller: nelmio_api_doc.controller。昂首阔步}
这是所有!你现在可以访问/ api / doc /内部
,/ api / doc /商业
和/ api / doc /商店
。
使用注释来过滤记录在每个地区航线
您可以使用“@Areas”注释内控制器定义路线的地区。
首先,您需要定义哪些地区将使用“@Areas”注释来过滤
应该记录的路线:
1 2 3 4 5 6
nelmio_api_doc:领域:默认值:path_patterns:(^ / api]内部:with_annotation:真正的
然后添加注释在控制器或行动:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
使用Nelmio\注释作为Nelmio;/ * * *@Nelmio\地区({“内部”})= >所有操作在这个控制器记录下“内部”区* /类MyController{/ * * *@Nelmio\地区({“内部”})= >这个动作记录在“内部”区* /公共函数指数(){…}}
这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。