fix #804 - add a parameter to disable swagger ui when not needed

[Simperfit]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#804
License	MIT
Doc PR	O

This PR add a parameter to disable swagger ui

[soyuka]

+1 this can be needed in correlation with #768

[dunglas]

I suggest to not register SwaggerUiListener at all if Swagger UI is deactivated instead of passing a flag in the listener's constructor. Cleaner code, and better performance.

[Simperfit]

@dunglas I've made the change

[meyerbaptiste]

And if $config['enable_swagger_ui'] is false?

[Simperfit]

It does not load swagger-ui, I don't understand what you mean

[Simperfit]

OH: We don't net to set it for the container if it's false anyway. Like we have done with enable_swagger.

[dunglas]

Thank you @Simperfit

[teohhanhui]

Does this address the use case of having Swagger UI at /docs, but disabling the "hijacking" of other paths?

[dunglas]

@teohhanhui yes as long as you register yourself the Swagger UI controller: #804 (comment)

[teohhanhui]

That's not very nice for DX 😞

[Simperfit]

@teohhanhui I think it's okay, not alot of people use the html encoders and if they do we will have to add a doc part about this.

What would be better ?

[teohhanhui]

Not many people use a HTML encoder, yes. But many people like myself would not want the hijacking (mostly just a marketing feature to me).

It'd be much better if the hijacking can be disabled by configuration.

I propose something like the following:

swagger_ui:
    # enabled: true
    intercept_operations: true

[soyuka]

I made a swagger configuration node in #768 :

swagger:
  enabled: true
  ui_enabled: true
  ui_path: '%kernel.root_dir%/../web/swagger-ui'

I'd propose:

swagger:
  enabled: true
  ui:
    enabled: true
    path: '%kernel.root_dir%/../web/swagger-ui'
    intercept_operations: true