API documentation gives 500 error

Hi, guys!

When I open /api/doc, I get 500 error. Here is what is written in logs:

request.CRITICAL: Uncaught PHP Exception Symfony\Component\Debug\Exception\FatalThrowableError: "Type error: Argument 1 passed to Oro\Bundle\ApiBundle\ApiDoc\Formatter\HtmlFormatter::setTemplatingEngine() must implement interface Symfony\Component\Templating\EngineInterface, instance of Environment_f327966 given, called in /opt/orocrm/var/cache/prod/ContainerC9urps9/getNelmioApiDoc_Formatter_HtmlFormatterService.php on line 43" at /opt/orocrm/vendor/oro/platform/src/Oro/Bundle/ApiBundle/ApiDoc/Formatter/HtmlFormatter.php line 91 {"exception":"[object] (Symfony\\Component\\Debug\\Exception\\FatalThrowableError(code: 0): Type error: Argument 1 passed to Oro\\Bundle\\ApiBundle\\ApiDoc\\Formatter\\HtmlFormatter::setTemplatingEngine() must implement interface Symfony\\Component\\Templating\\EngineInterface, instance of Environment_f327966 given, called in /opt/orocrm/var/cache/prod/ContainerC9urps9/getNelmioApiDoc_Formatter_HtmlFormatterService.php on line 43 at /opt/orocrm/vendor/oro/platform/src/Oro/Bundle/ApiBundle/ApiDoc/Formatter/HtmlFormatter.php:91)"} []

1 2 3 4 5 6

request.CRITICAL: Uncaught PHP Exception Symfony\Component\Debug\Exception\FatalThrowableError: "Type error: Argument 1 passed to Oro\Bundle\ApiBundle\ApiDoc\Formatter\HtmlFormatter::setTemplatingEngine() must implement interface Symfony\Component\Templating\EngineInterface, instance of Environment_f327966 given, called in /opt/orocrm/var/cache/prod/ContainerC9urps9/getNelmioApiDoc_Formatter_HtmlFormatterService.php on line 43" at /opt/orocrm/vendor/oro/platform/src/Oro/Bundle/ApiBundle/ApiDoc/Formatter/HtmlFormatter.php line 91 {"exception":"[object] (Symfony\\Component\\Debug\\Exception\\FatalThrowableError(code: 0): Type error: Argument 1 passed to Oro\\Bundle\\ApiBundle\\ApiDoc\\Formatter\\HtmlFormatter::setTemplatingEngine() must implement interface Symfony\\Component\\Templating\\EngineInterface, instance of Environment_f327966 given, called in /opt/orocrm/var/cache/prod/ContainerC9urps9/getNelmioApiDoc_Formatter_HtmlFormatterService.php on line 43 at /opt/orocrm/vendor/oro/platform/src/Oro/Bundle/ApiBundle/ApiDoc/Formatter/HtmlFormatter.php:91)"} []

How this can be fixed?

Thanks.
Andriy

Topic

[Andrey YatsenkoModerator]

It is a known issue introduced by NelmioApiDocBundle.
As a workaround, you can add to the require section of composer.json at the application lock to the previous version of the dependency by running composer require nelmio/api-doc-bundle:2.13.3
We are going to fix the compatibility in a further release.
Internal ticket id #BAP-18979

• This reply was modified 4 years, 10 months ago by  Andrey Yatsenko.

[s-andyParticipant]

Thanks, Andrey!
It works now.

[DustinParticipant]

S-andy, was there anything you did following Andrey’s instructions? I’ve attempted to run the “composer require nelmio/api-doc-bundle:2.13.3” command, and although it keeps saying there is nothing to install or update, and my composer.lock file has the 2.13.3 version listed, I still have yet to be able to access the API Doc, and am still getting the exact fault you originally were getting.

Any feedback is helpful!

[s-andyParticipant]

Dustin, no, I did not do any special steps (except cache reset, maybe).

[DustinParticipant]

I’ve tried that as well, figuring maybe the cache may need to be cleared, but still, nothing so I’m sort of lost. I’ll try it again, wonder if it’s processing in dev mode (if at all possible) when I’m running the command

[DustinParticipant]

Follow Up: Was able to get it working, finally. Not sure what did it (if it was the clearing of the cache again, or if it was the platform update.)

In either case, I’ve finally got access to the API Doc. Thanks

[Author]

Replies