Skip to content

Commit 6199961

Browse files
committed
Add details on documentation for AsyncAPI docs
1 parent 72ed197 commit 6199961

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ and [SOLID principles](https://en.wikipedia.org/wiki/SOLID).
2020

2121
This template provides out of the box some commonly used functionalities:
2222

23-
* API Documentation using [FastAPI](https://fastapi.tiangolo.com/)
23+
* Sync and Async API Documentation using [FastAPI](https://fastapi.tiangolo.com/) and [AsyncAPI](https://www.asyncapi.com/en)
2424
* Async tasks execution using [Dramatiq](https://dramatiq.io/index.html)
2525
* Repository pattern for databases using [SQLAlchemy](https://www.sqlalchemy.org/) and [SQLAlchemy bind manager](https://febus982.github.io/sqlalchemy-bind-manager/stable/)
2626
* Database migrations using [Alembic](https://alembic.sqlalchemy.org/en/latest/) (configured supporting both sync and async SQLAlchemy engines)

docs/api-documentation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
API documentation is rendered by [FastAPI](https://fastapi.tiangolo.com/features/)
44
on `/docs` and `/redoc` paths using OpenAPI format.
55

6+
AsyncAPI documentation is rendered using the
7+
[AsyncAPI react components](https://github.com/asyncapi/asyncapi-react).
8+
It is available on `/docs/ws` path.
9+
610
## API versioning
711

812
Versioning an API at resource level provides a much more

0 commit comments

Comments
 (0)