NelmioApiDocBundle
编辑本页警告:您正在浏览版本文档欧宝官网下载app2.倍它不再被维护了。
如果您的一些项目仍在使用此版本,请考虑升级。
NelmioApiDocBundle
的NelmioApiDocBundlebundle允许你为你的api生成一个像样的文档。欧宝官网下载app
第一步:下载软件包
打开命令控制台,进入您的项目目录并执行以下命令来下载此包的最新稳定版本:
1
$ composer require nelmio/api-doc-bundle:^2.0
该命令要求全局安装Composer,如中所述安装一章的Composer文档。欧宝官网下载app
步骤2:启用Bundle
方法中的注册包列表中添加该包,从而启用该包app / AppKernel.php
项目文件:
12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?php/ / app / AppKernel.php/ /……类AppKernel扩展内核{公共函数registerBundles(){$包=数组(/ /……新Nelmio \ ApiDocBundle \ NelmioApiDocBundle ());/ /……}/ /……}
步骤3:注册路由
中导入路由定义routing.yml
:
1 2 3 4
# app / config / routing.ymlNelmioApiDocBundle:资源:“@NelmioApiDocBundle /资源/ config / routing.yml”前缀:/ api /医生
步骤4:配置Bundle
中启用bundle的配置应用程序/配置/ config.yml
:
1 2
# app / config / config.ymlnelmio_api_doc:~
的NelmioApiDocBundle需要Twig作为模板引擎,所以不要忘记启用它:
1 2 3 4
# app / config / config.yml框架:模板:发动机:(“树枝”)
使用
文档的主要问题是保持它的更新。欧宝官网下载app这就是为什么NelmioApiDocBundle经常使用自省。多亏了注释,可以很容易地记录API方法。以下章节将帮助你建立你的API文档:欧宝官网下载app
Web界面
你可以浏览整个文档:欧宝官网下载apphttp://example.org/api/doc
.
动态文档欧宝官网下载app
通过使用参数调用URL? _doc = 1
,你会得到相应的文件(如有)。欧宝官网下载app
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。