From 1a3cca97122a44f32ebe88feabdefb5c724b6e35 Mon Sep 17 00:00:00 2001 From: Peter Vacho Date: Mon, 30 Dec 2024 19:02:48 +0100 Subject: [PATCH] Mention the swagger documentation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2432960..42a8697 100644 --- a/README.md +++ b/README.md @@ -296,3 +296,10 @@ virtual environment and then run: ```bash python populate_db.py ``` + +## Documentation + +The project includes a Swagger UI documentation, which is automatically generated by FastAPI through the OpenAPI schema. + +You can access it on the `/docs` endpoint, e.g. if you're running the project on `localhost:8000`, you can access the +documentation at .