Offline/firewalled mode

[choobinejad]

There are several pointers in swagger-ui.js and swagger-ui-bundle.js to https://online.swagger.io/validator. These pointers cause the swagger UI to freeze.

Would it be possible to document "offline deployment" instructions, or even provide a configuration for whether or not the UI should try to access resources on external domains?

[Reinami]

Would have to look into this.

[fredyw]

Disabling online validator can be done by setting validatorUrl to null in SwaggerUIBundle of index.html. I'm not sure if there's an easy way to configure this in Python, though.

[jasper9]

+1 for this

[hampsterx]

https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

this is an option as I don't think templating index.html is suitable.

configUrl: 'swagger-config',

then have a route for it in swagger.py

@blueprint.route('/swagger-config')
@doc_route(exclude=True)
def config(request):

    options = {}

    if hasattr(request.app.config, 'API_VALIDATOR_URL'):
        options['validatorUrl'] = getattr(request.app.config, 'API_VALIDATOR_URL')

    return json(options)

@ahopkins @DirkGuijt I can do a PR for this if happy with this approach. I am in need of this solution also as many of our APIs are internal.

[LTMenezes]

+1 for this.

I think a quick solution to this issue would be to add another option in the "app.config" in order to make the validator URL customizable. This way we would enable sanic-openapi users to disable the validation or to provide a custom validator URL.

What do you guys think about this approach? I would be happy to submit a PR for this.
@hampsterx @chenjr0719

[hampsterx]

@LTMenezes go for it~

[chenjr0719]

@LTMenezes Sounds good.