What is the best way to disable the documentation in production ?

[bbarhoum1]

I'm trying to hide/disable documentation for the production. The configuration option 'enable_docs' is not working for me.
It works with this cong:

when@prod:
    api_platform:
        enable_docs: false
        enable_swagger_ui: false
        enable_re_doc: false
        enable_swagger: false
        enable_entrypoint: false

Is this the best way or there is an issue with the "enable_docs" configuration ?
Thank you for your help :)

[pauljura]

Hi, I'm not sure if this is the best way but this is how I do it, in my routes.yaml file:

swagger_ui:
    path: /docs
    controller: api_platform.swagger_ui.action
    condition: "'%kernel.environment%' != 'prod'"

[royvangeel]

Could someone from the API Platform team advise on the recommended way to completely disable the API documentation in production?
Based on the naming, I expected enable_docs to handle this or is there a different or updated approach we should be using?

Additionally, when html is added as a format in api_platform.yaml, and enable_docs is set to false, accessing any endpoint in the browser still renders the API documentation (due to content negotiation with text/html).

Thanks in advance!

[soyuka]

Indeed there's a problem when you call a resource with the html accept header (though the docs is correctly disabled), I crafted a fix at
see #7806

[royvangeel]

Nice, any idea when this will be released?