Merge pull request #33 from olexandr-klymenko/master

Add support for aiohttp Nested Applications

Author: cr0hn

aiohttp_swagger/__init__.py

@@ -91,8 +91,10 @@ def setup_swagger(app: web.Application,
     with open(join(STATIC_PATH, "index.html"), "r") as f:
         app["SWAGGER_TEMPLATE_CONTENT"] = (
             f.read()
-            .replace("##SWAGGER_CONFIG##", _swagger_def_url)
-            .replace("##STATIC_PATH##", statics_path)
+            .replace("##SWAGGER_CONFIG##", '/{}{}'.
+                     format(api_base_url.lstrip('/'), _swagger_def_url))
+            .replace("##STATIC_PATH##", '/{}{}'.
+                     format(api_base_url.lstrip('/'), statics_path))
         )
 
 

doc/source/customizing.rst

@@ -166,4 +166,33 @@ Global Swagger YAML
 
     setup_swagger(app, swagger_from_file="example_swagger.yaml")  # <-- Loaded Swagger from external YAML file
 
+    web.run_app(app, host="127.0.0.1")
+
+Nested applications
++++++++++++++++++++
+
+:samp:`aiohttp-swagger` is compatible with aiohttp `Nested applications <http://aiohttp.readthedocs.io/en/stable/web.html>`_ feature.
+In this case `api_base_url` argument of `setup_swagger` function should be the same as `prefix` argument of `add_subapp` method:
+
+
+.. code-block:: python
+
+    from aiohttp import web
+    from aiohttp_swagger import *
+
+    async def ping(request):
+        return web.Response(text="pong")
+
+    sub_app = web.Application()
+
+    sub_app.router.add_route('GET', "/ping", ping)
+
+    setup_swagger(sub_app,
+                  swagger_from_file="example_swagger.yaml",
+                  api_base_url='/sub_app_prefix')
+
+    app = web.Application()
+
+    app.add_subapp(prefix='/sub_app_prefix', subapp=sub_app)
+
     web.run_app(app, host="127.0.0.1")

tests/test_swagger.py

@@ -272,3 +272,25 @@ def test_class_view(test_client, loop):
     assert "/class_view" in result['paths']
     assert "patch" not in result['paths']["/class_view"]
 
+
+@asyncio.coroutine
+def test_sub_app(test_client, loop):
+    sub_app = web.Application(loop=loop)
+    sub_app.router.add_route('*', "/class_view", ClassView)
+    setup_swagger(sub_app, api_base_url='/sub_app')
+    app = web.Application(loop=loop)
+    app.add_subapp(prefix='/sub_app', subapp=sub_app)
+
+    client = yield from test_client(app)
+    # GET
+    resp = yield from client.get('/sub_app/class_view')
+    assert resp.status == 200
+    text = yield from resp.text()
+    assert 'OK' in text
+    swagger_resp1 = yield from client.get('/sub_app/api/doc/swagger.json')
+    assert swagger_resp1.status == 200
+    text = yield from swagger_resp1.text()
+    result = json.loads(text)
+    assert "/class_view" in result['paths']
+    assert "get" in result['paths']["/class_view"]
+    assert "post" in result['paths']["/class_view"]