API_DOC endpoint is mandatory after upgrade to ApiPlatform 4.0

[jkabat]

API Platform version(s) affected: 4.0.10

Description
After upgrade my JSON-LD API does not work when I have setting API_DOC: FALSE (I do not want to expose it for production)

Additional Context
I'm getting RouteNotFoundException

Unable to generate a URL for the named route "api_doc" as such route does not exist.

Am I missing something?

[petski]

I'm getting this whenever I throw an exception. The RouteNotFoundException comes from vendor/api-platform/hydra/State/HydraLinkProcessor.php:48 in my case.

My setup:

• I'm running v4.0.11
• .env.dev with DOCS_ENABLE=false
• config/packages/api_platform.yaml has:

  ...snip...
  enable_docs: "%env(bool:DOCS_ENABLE)%"
  enable_entrypoint: "%env(bool:DOCS_ENABLE)%"
  enable_swagger: "%env(bool:DOCS_ENABLE)%"
  enable_swagger_ui: "%env(bool:DOCS_ENABLE)%"
  enable_re_doc: "%env(bool:DOCS_ENABLE)%"
  ...snip...
  

• Env resolving works just fine:

  $ bin/console debug:config --resolve-env api_platform | egrep 'enable_(docs|entrypoint|swagger|re_doc)'
      enable_docs: false
      enable_entrypoint: false
      enable_swagger: false
      enable_swagger_ui: false
      enable_re_doc: false
  

Now the curious part (!!): If I bypass the %env-way, and set the values to false directly, I do not hit this issue (!).

@jkabat Can you confirm you have this too?

Notes to self:

• https://github.com/api-platform/core/issues?q=is%3Aissue+api_doc+is%3Aclosed has a couple of related issues
• Error after disabling docs : Unable to generate a URL for the named route \"api_doc\" as such route does not exist. #3937 (comment)

[soyuka]

The HydraLinkProcessor gets removed at:

core/src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

Lines 540 to 543 in bd0e929

	if (!$config['enable_docs']) {
	$container->removeDefinition('api_platform.hydra.listener.response.add_link_header');
	$container->removeDefinition('api_platform.hydra.processor.link');
	}

Do you still experience this? Can you check there why this service doesn't get removed or check if the service is loaded? Thanks!

[petski]

The value of $config['enable_docs'] on line 539 of vendor/api-platform/symfony/Bundle/DependencyInjection/ApiPlatformExtension.php is env_6a1104280fc2a530_bool_DOCS_ENABLE_04563426aed8d72ea9b01c28f8183a50 (which will evaluate to true).

As mentioned in my previous comment, it's value in the config is "%env(bool:DOCS_ENABLE)%"

HTH

[soyuka]

Not sure how to fix this it's like your env variable didn't got updated?

[petski]

It seems registerJsonLdHydraConfiguration() is called before the config is (fully) interpreted/resolved.

As seen in #6848 (comment), with --resolve-env the env variables are interpreted as they should.

[jkabat]

I used some temporary solution for now (found here in issues). When I get some time, I will do more research regarding your findings.

[petski]

Meanwhile, can you please share your temporary solution? Please bump this issue once you've found the root cause.

[petski]

#7062 seems related

[soyuka]

issue from 2024 and then pr from 2025 ? Does #7062 fixes the issue? please open a new issue with a reproducer

[petski]

Sorry for the confusion, @soyuka. After this issue (#6848) got closed, I ended up decorating api_platform.route_loader and inject a api_doc route if not present as a workaround. Yesterday I bumped to API Platform v4.1.7 and the workaround I had in place wasn't needed anymore. Iterating the changelog, I suspected #7062 to be the fix for this issue (#6848), hence the "#7062 seems related" remark. I meant to say "#7062 seems a possible fix for this issue". Mea culpa

[soyuka]

👍 thanks for the detail glad you found a resolution to your issue :)