Serve correct openapi spec basepath when path is altered by reverse-proxy

[dtkav]

Fixes #820
Fixes #392
Fixes #527

Changes proposed in this pull request:

• change swagger-ui, and openapi spec location to build the path using url_for
• modify the openapi spec basePath or servers block to include the reversed api path
• modify the swagger-ui page to load the reversed openapi spec using url_for
• add a openapi3/reverseproxy example
• add a openapi3/reverseproxy_aiohttp example

Thanks to @Jyhess for the collaboration, tests, and review!

[bhechinger]

That fixes the Explore bar nicely so the spec is loaded into the UI Console.

That also sets the link to the spec file correctly.

The Try it out section still has the wrong URL, however.

[dtkav]

Ah ok - great thanks for the feedback. I need to set up a proper test environment :)
@Jyhess also has a similar PR at #826 if you want to try that out and provide feedback.

[dtkav]

note: this doesn't yet work with aiohttp

[dtkav]

hey @bhechinger - can you try out the latest example, and let me know if it is working for you?

[dtkav]

The build is broken because of #844

[dtkav]

I think I have this pretty much where I want it. It could be a bit more DRY.

Potential future work could be to actually add the reverse proxy code to connexion/apps/*.
This would need to be done carefully, since it's very easy to mess up and easy to cause security problems.

I think for now it's probably best to leave it as an example for the user to learn about and adapt to their use case.

[dtkav]

I'm stuck on a single aiohttp test in python 3.4, where it seems to think that aiohttp is installed after calling sys.modules.pop("aiohttp").
Does anyone know what's going on there? I'm not able to reproduce it locally.

[Jyhess]

I'm stuck on a single aiohttp test in python 3.4, where it seems to think that aiohttp is installed after calling sys.modules.pop("aiohttp").
Does anyone know what's going on there? I'm not able to reproduce it locally.

Not reproduced on my side either, but you can try another strategy with mocker:

def test_run_with_aiohttp_not_installed(mock_app_run, spec_file, mocker):
    import sys
    mocker.patch.dict(sys.modules, {'aiohttp': None})
    runner = CliRunner()

    # missing aiohttp
    result = runner.invoke(main,
                           ['run', spec_file, '-f', 'aiohttp'],
                           catch_exceptions=False)

    assert 'aiohttp library is not installed' in result.output
    assert result.exit_code == 1

[dtkav]

@Jyhess thanks for your help. I was able to sort it out by using mock.

[dtkav]

@jmcs can you take a look at this one please?

[Jyhess]

Better to specify extra dependency:
sudo pip3 install --upgrade connexion[swagger-ui] aiohttp-remotes

[dtkav]

good catch! oops

[Jyhess]

I think it should not be part of project dependencies when it is used only in an example

[dtkav]

yeah, but it is needed for the unit tests. I'll add it to setup.py under test-requres for > python 3.5.2

[dtkav]

Hey @hjacobs if you find some time - these changes will enable people to use connexion behind a path-altering reverse proxy (like AWS API Gateway).

[dtkav]

@hjacobs can you please take a look at this fix for path-altering reverse proxies?

[dtkav]

@rafaelcaricio are you happy with the changes to address your comments?

[cognifloyd]

This looks great and needs to be merged. 👍 I have a few minor nitpicks, but it can be merged without addressing them.

[dtkav]

@hjacobs can you please have a look?

[hjacobs]

👍