I\'m developing an API with Symfony 3 and I want to use apidoc to create a documentation. Apidoc works with annotations:
/**
* @api {get} /user/:id Request
There is also a way to ignore an annotation globally. We didn't want to annotate each class, so we added this to our bootstrap file web/app.php
.
Doctrine\Common\Annotations\AnnotationReader::addGlobalIgnoredName('your-custom-annotation');
There's an @IgnoreAnnotation Doctrine annotation you can use. Try this:
/**
* @IgnoreAnnotation("api")
* @IgnoreAnnotation("apiName")
* @IgnoreAnnotation("apiGroup")
* @IgnoreAnnotation("apiParam")
* @IgnoreAnnotation("apiSuccess")
*/
class SomeController extends Controller{
...
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
The documentation is further down in that link.