mirror of
https://github.com/LukeHagar/connexion.git
synced 2025-12-06 04:19:26 +00:00
Fixes #206 - Handle nested paths in swagger definitions. - Allow nested paths to be handled in `get` and `search` handlers An explicit decision has been made to resolve paths (with a prefix like `my.api`) like: - `/hello/{hello_id}/world` --> `my.api.hello.world:search(hello_id)` - `/hello/world/{world_id}` --> `my.api.hello.world:get(world_id)`
210 lines
5.9 KiB
Python
210 lines
5.9 KiB
Python
from connexion.operations import OpenAPIOperation
|
|
from connexion.resolver import Resolver, RestyResolver
|
|
|
|
COMPONENTS = {'parameters': {'myparam': {'in': 'path', 'schema': {'type': 'integer'}}}}
|
|
|
|
|
|
def test_standard_resolve_x_router_controller():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='endpoint',
|
|
path_parameters=[],
|
|
operation={
|
|
'x-openapi-router-controller': 'fakeapi.hello',
|
|
'operationId': 'post_greeting',
|
|
},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=Resolver()
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.post_greeting'
|
|
|
|
|
|
def test_resty_resolve_operation_id():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='endpoint',
|
|
path_parameters=[],
|
|
operation={
|
|
'operationId': 'fakeapi.hello.post_greeting',
|
|
},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.post_greeting'
|
|
|
|
|
|
def test_resty_resolve_x_router_controller_with_operation_id():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='endpoint',
|
|
path_parameters=[],
|
|
operation={
|
|
'x-openapi-router-controller': 'fakeapi.hello',
|
|
'operationId': 'post_greeting',
|
|
},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.post_greeting'
|
|
|
|
|
|
def test_resty_resolve_x_router_controller_without_operation_id():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello/{id}',
|
|
path_parameters=[],
|
|
operation={'x-openapi-router-controller': 'fakeapi.hello'},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi'))
|
|
assert operation.operation_id == 'fakeapi.hello.get'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello/{id}',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.get'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello/{id}/world',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.world.search'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_lowercase_verb():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='get',
|
|
path='/hello/{id}',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.get'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_lowercase_verb_nested():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='get',
|
|
path='/hello/world/{id}',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.world.get'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_translate_dashes_in_resource_name():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/foo-bar',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.foo_bar.search'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_can_resolve_api_root():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.get'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_get_as_search():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.search'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_and_x_router_controller_will_resolve_resource_root_get_as_search():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello',
|
|
path_parameters=[],
|
|
operation={
|
|
'x-openapi-router-controller': 'fakeapi.hello',
|
|
},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.search'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_as_configured():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='GET',
|
|
path='/hello',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi', 'api_list')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.api_list'
|
|
|
|
|
|
def test_resty_resolve_with_default_module_name_will_resolve_resource_root_post_as_post():
|
|
operation = OpenAPIOperation(
|
|
api=None,
|
|
method='POST',
|
|
path='/hello',
|
|
path_parameters=[],
|
|
operation={},
|
|
app_security=[],
|
|
components=COMPONENTS,
|
|
resolver=RestyResolver('fakeapi')
|
|
)
|
|
assert operation.operation_id == 'fakeapi.hello.post'
|