Skip to content

Commit e2e8d44

Browse files
committed
Updated README.
Signed-off-by: Pavel Kirilin <win10@list.ru>
1 parent 9da308b commit e2e8d44

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,25 @@ main_router.add_routes(api_router, prefix="/api")
6565
main_router.add_routes(memes_router, prefix="/memes")
6666
```
6767

68+
## Swagger
69+
70+
If you use dependencies in you handlers, we can easily generate swagger for you.
71+
We have some limitations:
72+
1. We don't support string type annotation for detecting required parameters in openapi. Like `a: "Optional[int]"`.
73+
2. We don't have support for 3.10 style Option annotations. E.G. `int | None`
74+
75+
We will try to fix these limitations later.
76+
77+
To enable swagger, just add it to your startup.
78+
79+
```python
80+
from aiohttp_deps import init, setup_swagger
81+
82+
app = web.Application()
83+
84+
app.on_startup.extend([init, setup_swagger()])
85+
```
86+
6887

6988
## Default dependencies
7089

tests/test_isoptional.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def tfunc(param: Union[int, None]):
3333
assert _is_optional(param)
3434

3535

36-
def test_unioned_optional():
36+
def test_unioned():
3737
def tfunc(param: Union[int, str]):
3838
"""Nothing."""
3939

0 commit comments

Comments
 (0)