Обход Аннотация Symfony2

В настоящее время я создаю RESTful API с использованием Symfony2.

Чтобы создать простую и понятную документацию, я хочу использовать 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.

2

Решение

использование @ignoreAnnotation.

При использовании другой библиотеки или программы (например, Doxygen), которая использует
аннотации, вы должны разместить аннотацию @IgnoreAnnotation на
класс, чтобы указать, какие аннотации Symfony должен игнорировать.

2

Другие решения

Взгляни на Пакет Нельмио Апи Док. Это позволяет генерировать документацию аналогичным образом (по аннотациям).

0

По вопросам рекламы [email protected]