Bypass Annotation Symfony2

Question

I'm currently building a RESTful API using Symfony2.

In order to create a simple and clean documentation, I wish to use apidoc.js (I really would prefer to use this one, but if you have anything else to auto generate api documentation feel free to share).

This generator uses annotations which are parsed by Symfony kernel (apparently, from what I understand)

Here is my code for a controller

/**
 * @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(){}

Sadly, Symfony parses this, and throws me an error :

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

Would you happen to have a solution to either prevent Symfony from parsing annotations (I'm always using YAML, so Symfony annotations are of no use to me actually), or just import those?

I'm quite new at this and I'm still struggling with creating a reliable and clean Symfony application.

score 2 · Accepted Answer · answered Dec 20 '15 at 01:31

2

Use @ignoreAnnotation.

When using another library or program (e.g. Doxygen) that uses annotations, you should place the @IgnoreAnnotation annotation on the class to indicate which annotations Symfony should ignore.

answered Dec 20 '15 at 01:31

Aerendir

6,152
9
55
108

Thanks a lot, that was exactly what I was looking for! – Paul Gabriel Dec 20 '15 at 12:43
Is there a way to ignore annotations application wide? – Saeed Falsafin Sep 18 '18 at 10:37

score 0 · Answer 2 · answered Dec 20 '15 at 05:52

0

Take a look at Nelmio Api Doc Bundle. It allows to generate documentation the similar way (by annotations).

answered Dec 20 '15 at 05:52

Serge Kvashnin

4,332
4
23
37

Bypass Annotation Symfony2

2 Answers2