2

我目前正在使用 Symfony2 构建一个 RESTful API。

为了创建一个简单而干净的文档,我希望使用apidoc.js(我真的更喜欢使用这个,但是如果您有其他任何东西可以自动生成 api 文档,请随时分享)。

该生成器使用由 Symfony 内核解析的注释(显然,据我了解)

这是我的控制器代码

/**
 * @api {get} /contact/list Request Contacts List
 * @apiName List Contacts
 * @apiGroup Contacts
 *
 * @apiSuccess {Integer} Status
 * @apiSuccess {String} Custom Message to be displayed
 */
public function clientListAction(){}

可悲的是,Symfony 解析了这个,并给我一个错误:

[Semantical Error] The annotation "@apiName" in method AppBundle\Controller\ClientApiController::clientListAction() was never imported.

您是否碰巧有一个解决方案来阻止 Symfony 解析注释(我一直在使用 YAML,所以 Symfony 注释实际上对我没有用),或者只是导入那些?

我对此很陌生,我仍在努力创建一个可靠且干净的 Symfony 应用程序。

4

2 回答 2

2

使用@ignoreAnnotation.

当使用另一个使用注解的库或程序(例如 Doxygen)时,您应该在类上放置 @IgnoreAnnotation 注解以指示 Symfony 应该忽略哪些注解。

于 2015-12-20T01:31:36.237 回答
0

看看Nelmio Api Doc Bundle。它允许以类似的方式(通过注释)生成文档。

于 2015-12-20T05:52:19.897 回答