配置深入
编辑本页警告:您正在浏览版本文档欧宝官网下载app2.倍它不再被维护了。
如果您的一些项目仍在使用此版本,请考虑升级。
配置深入
身份验证方法
您可以选择不同的认证方式:
12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20
# app / config / config.ymlnelmio_api_doc:沙盒:身份验证:交付:头名称:X-Custom# app / config / config.ymlnelmio_api_doc:沙盒:身份验证:交付:查询名称:参数# app / config / config.ymlnelmio_api_doc:沙盒:身份验证:交付:http类型:基本#或承载者
当选择http
交付,的名字
默认为授权
,并且头值将自动以相应的类型(即。基本
或持票人
).
部分排除
您可以指定从文档生成中排除哪些部分:欧宝官网下载app
1 2 3
# app / config / config.ymlnelmio_api_doc:exclude_sections:[" privateapi ",“testapi”]
请注意,exclude_sections
将从API文档中排除一个部分。欧宝官网下载app属性可以创建多个视图的观点
参数中的@ApiDoc
注释。这允许您将私有方法或测试方法移动到文档的完全不同的视图中。欧宝官网下载app
解析器
默认情况下,将使用所有已注册的解析器,但有时可能需要定义要使用哪些解析器。的解析器
属性用于配置将要使用的解析器列表:
1 2 3 4 5 6 7
输出= {“类”=“Acme \包\实体\用户”,“解析”= {“解析器Nelmio \ ApiDocBundle \ \ JmsMetadataParser”,“解析器Nelmio \ ApiDocBundle \ \ ValidationParser”}}
在本例中是解析器JmsMetadataParser
而且ValidationParser
用于生成返回的数据。该特性也适用于输入
而且输出
属性。
此外,该bundle提供了一种注册多个的方法输入
解析器。可以处理指定输入的第一个解析器将被使用,因此您可以通过容器标记配置它们的优先级。下面是一个解析器服务注册的例子:
1 2 3 4 5 6
# app / config / config.yml服务:mybundle.api_doc.extractor.custom_parser:类:MyBundle \解析器\ CustomDocParser标签:-{名称:nelmio_api_doc.extractor.parser,优先级:2}
公告
您还可以定义自己的motd内容(上面的方法列表)。你所要做的就是添加到配置:
1 2 3 4 5
# app / config / config.ymlnelmio_api_doc:#……公告:模板:/ motd.html.twig AcmeApiBundle:组件
缓存
在生产环境中启用内部缓存机制是个好主意:
1 2 3 4
# app / config / config.ymlnelmio_api_doc:缓存:启用:真正的
你可以定义一个备用的ApiDoc配置缓存的位置:
1 2 3 4 5
# app / config / config.ymlnelmio_api_doc:缓存:启用:真正的文件:“/ tmpob娱乐下载 / symfony-app / % kernel.environment % / api-doc.cache”
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。