ap7pd/event-management-backend
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Mention the swagger documentation

Browse source
This commit is contained in:
Peter Vacho 2024-12-30 19:02:48 +01:00
parent e47c2a33d7
commit 1a3cca9712
Signed by: school
GPG key ID: 8CFC3837052871B4
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -296,3 +296,10 @@ virtual environment and then run:
```bash ```bash
python populate_db.py 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 <http://localhost:8000/docs>.