Allow for multiple SwaggerDocs in a single web.Application. #104

garyvdm · 2022-10-14T06:03:38Z

No description provided.

codecov · 2022-10-14T06:07:00Z

Codecov Report

Base: 98.77% // Head: 98.77% // No change to project coverage 👍

Coverage data is based on head (58d5bec) compared to base (705ee77).
Patch has no changes to coverable lines.

❗ Current head 58d5bec differs from pull request most recent head f894dfe. Consider uploading reports for the commit f894dfe to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   98.77%   98.77%           
=======================================
  Files          14       14           
  Lines        1302     1302           
=======================================
  Hits         1286     1286           
  Misses         16       16

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

hh-h · 2022-10-14T06:47:30Z

Hello, thank you for your PR. Could you please describe the case it solves?

garyvdm · 2022-10-14T12:09:18Z

We have an app that has an api that we need to change. Our plan is to have a v1 api, and a v2 api, with the v1 api deprecated. (We have users of the v1 api that won't be able to change immediately, and so we will need to still support the v1 api with compatibility code.)

I would like to provide 2 swagger docs for the 2 apis version, from the same aiohttp app.

hh-h · 2022-10-18T16:55:09Z

Thank you for the explanation, I'll take a look.

aiohttp_swagger3/swagger.py

aiohttp_swagger3/ui_settings.py

garyvdm · 2022-12-15T11:36:02Z

Sorry for the delay. I had a break from work.

Not sure why the builds are failing. I don't think it related change, but I'm investigating.

garyvdm · 2023-01-30T17:52:34Z

Woot, thank you for fixing the CI .

I've rebased to the latest from master.

hh-h

First of all, I want to apologize for the very long review. I took the time to read the changes and I want to say that it is a very good idea and implementation.

Now you can have conflicts between swagger instances, you should add a check for conflicts right below https://github.com/hh-h/aiohttp-swagger3/pull/104/files#diff-a2cd31a0003fe58689bade08ea5f0a88483ea36acd0569c0f47b90c0c39f6da2R100

Something like this

for route in self._app.router.routes():
    if ui_path == route.resource.canonical:
        raise Exception(f"I'm very bad at wording, please come up with something using {ui_path} and {route.resource.canonical}, thanks :)")

And you should also add a test for this change.

Also please add a usage example in examples/ but I wrote it for you, so just put it there :)

from aiohttp import web

from aiohttp_swagger3 import RapiDocUiSettings, ReDocUiSettings, SwaggerDocs, SwaggerUiSettings


async def handler(request):
    """
    ---
    responses:
      '200':
        description: OK.

    """
    return web.json_response()


def main():
    app = web.Application()
    swagger1 = SwaggerDocs(
        app,
        swagger_ui_settings=SwaggerUiSettings(path="/swagger1"),
        redoc_ui_settings=ReDocUiSettings(path="/redoc1"),
        rapidoc_ui_settings=RapiDocUiSettings(path="/rapidoc1"),
    )
    swagger1.add_routes([web.get("/handler1", handler, allow_head=False)])

    swagger2 = SwaggerDocs(
        app,
        swagger_ui_settings=SwaggerUiSettings(path="/swagger2"),
        redoc_ui_settings=ReDocUiSettings(path="/redoc2"),
        rapidoc_ui_settings=RapiDocUiSettings(path="/rapidoc2"),
    )
    swagger2.add_routes([web.get("/handler2", handler, allow_head=False)])

    web.run_app(app)


if __name__ == "__main__":
    main()

hh-h · 2023-02-04T06:10:51Z

aiohttp_swagger3/routes.py



-async def _swagger_spec(request: web.Request) -> web.Response:
+async def _swagger_spec(spec: Any, request: web.Request) -> web.Response:


replace Any with Dict

hh-h · 2023-02-04T06:12:42Z

aiohttp_swagger3/routes.py

-
-async def _rapidoc_ui(request: web.Request) -> web.Response:
-    return web.Response(text=request.app[_RAPIDOC_UI_INDEX_HTML], content_type="text/html")
+async def _ui(ui_text: str, request: web.Request) -> web.Response:


please, rename it to _ui_handler

hh-h · 2023-02-04T06:13:38Z

tests/test_swagger.py

+    assert resp1_json["info"]["title"] == "test app 1"
+    assert "/handler1" in resp1_json["paths"]
+
+    resp1 = await client.get("/docs2/swagger.json")


should be resp2

hh-h · 2023-02-04T06:14:12Z

tests/test_swagger.py

+    assert resp1.status == 200
+    resp1_json = await resp1.json()
+    assert resp1_json["info"]["title"] == "test app 1"
+    assert "/handler1" in resp1_json["paths"]


also check that /handler2 not it resp1_json["paths"]

hh-h · 2023-02-04T06:14:33Z

tests/test_swagger.py

+    assert resp1.status == 200
+    resp1_json = await resp1.json()
+    assert resp1_json["info"]["title"] == "test app 2"
+    assert "/handler2" in resp1_json["paths"]


also check that /handler1 not it resp2_json["paths"]

garyvdm force-pushed the multi-tenant branch 2 times, most recently from 5ed8c29 to 915102c Compare November 7, 2022 16:40

hh-h requested changes Nov 7, 2022

View reviewed changes

aiohttp_swagger3/swagger.py Outdated Show resolved Hide resolved

aiohttp_swagger3/swagger.py Outdated Show resolved Hide resolved

aiohttp_swagger3/ui_settings.py Outdated Show resolved Hide resolved

garyvdm force-pushed the multi-tenant branch from 915102c to f894dfe Compare December 15, 2022 11:24

hh-h closed this Jan 29, 2023

hh-h reopened this Jan 29, 2023

Allow for multiple SwaggerDocs in a single web.Application.

9933983

garyvdm force-pushed the multi-tenant branch from f894dfe to 9933983 Compare January 30, 2023 17:45

hh-h requested changes Feb 4, 2023

View reviewed changes

hh-h self-assigned this Feb 4, 2023

Repository owner deleted a comment Jan 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow for multiple SwaggerDocs in a single web.Application. #104

Allow for multiple SwaggerDocs in a single web.Application. #104

garyvdm commented Oct 14, 2022

codecov bot commented Oct 14, 2022 •

edited

Loading

hh-h commented Oct 14, 2022

garyvdm commented Oct 14, 2022 •

edited

Loading

hh-h commented Oct 18, 2022

garyvdm commented Dec 15, 2022

garyvdm commented Jan 30, 2023

hh-h left a comment •

edited

Loading

hh-h Feb 4, 2023

hh-h Feb 4, 2023

hh-h Feb 4, 2023

hh-h Feb 4, 2023 •

edited

Loading

hh-h Feb 4, 2023 •

edited

Loading



		async def _swagger_spec(request: web.Request) -> web.Response:
		async def _swagger_spec(spec: Any, request: web.Request) -> web.Response:

Allow for multiple SwaggerDocs in a single web.Application. #104

Are you sure you want to change the base?

Allow for multiple SwaggerDocs in a single web.Application. #104

Conversation

garyvdm commented Oct 14, 2022

codecov bot commented Oct 14, 2022 • edited Loading

Codecov Report

hh-h commented Oct 14, 2022

garyvdm commented Oct 14, 2022 • edited Loading

hh-h commented Oct 18, 2022

garyvdm commented Dec 15, 2022

garyvdm commented Jan 30, 2023

hh-h left a comment • edited Loading

Choose a reason for hiding this comment

hh-h Feb 4, 2023

Choose a reason for hiding this comment

hh-h Feb 4, 2023

Choose a reason for hiding this comment

hh-h Feb 4, 2023

Choose a reason for hiding this comment

hh-h Feb 4, 2023 • edited Loading

Choose a reason for hiding this comment

hh-h Feb 4, 2023 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Oct 14, 2022 •

edited

Loading

garyvdm commented Oct 14, 2022 •

edited

Loading

hh-h left a comment •

edited

Loading

hh-h Feb 4, 2023 •

edited

Loading

hh-h Feb 4, 2023 •

edited

Loading