Блог

Можно ли создать документацию для RESTful API без аннотаций, но, скажем, с конфигурационным файлом?

что-то вроде этого:

 [<route name>|MyBundleBundleUser]:
    "@ApiDoc(
        statusCodes={
        200="Returned when successful",
        403="Returned when the user is not authorized to say hello",
        404={
            "Returned when the user is not found",
            "Returned when something else is not found"
        }
     }
    )"
...
 

Мне это нужно, потому что наш текущий API наследует поведение CRUD от суперкласса, вместо того, чтобы иметь дочерний метод для каждого запроса.

Итак, вместо того, чтобы иметь кучу уродливых методов, подобных этому:

 ...

public function readAction()
{
    parent::readAction();
}
...
 

Я бы предпочел сделать, если возможно, какой-нибудь патч для имитации поведения аннотаций и автоматической генерации конфигурационного файла аннотаций.

Кто-нибудь делал что-то подобное?

Спасибо.