2022-03-17 22:18:36 +00:00
|
|
|
# Dokumentation
|
|
|
|
|
|
2022-03-22 09:44:28 +00:00
|
|
|
## Swagger Documentation
|
2022-09-17 22:39:03 +00:00
|
|
|
Visit \<API_URL\> + /docs
|
2022-03-22 09:44:01 +00:00
|
|
|
|
2022-03-17 22:18:36 +00:00
|
|
|
## API
|
|
|
|
|
- `api/openapi.json`
|
|
|
|
|
- OpenAPI-Dokumentation
|
|
|
|
|
- von APIFlask generiert
|
|
|
|
|
- kann in Postman importiert werden
|
|
|
|
|
- `api/postman.json`
|
|
|
|
|
- Postman Collection
|
|
|
|
|
|
|
|
|
|
## Database
|
|
|
|
|
- `database/structure_database.pdf`
|
|
|
|
|
- Relationales Modell der Datenbank
|
|
|
|
|
- `database/structure_database.uxf`
|
|
|
|
|
- Relationales Modell der Datenbank
|
|
|
|
|
- Source Datei des Modells
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
- `requirements/2022-03-15 Anforderungen an Projekt.pdf`
|
2022-03-17 23:06:24 +00:00
|
|
|
- Anforderungen an dieses Projekt
|
|
|
|
|
|
|
|
|
|
## Role-model
|
|
|
|
|
Function|Admin|No Admin|
|
|
|
|
|
|---|---|---|
|
|
|
|
|
|Delete user|yes|only current user|
|
|
|
|
|
|Update users|yes|only current user|
|
|
|
|
|
|Set admin state|yes|no|
|
2022-03-22 09:44:01 +00:00
|
|
|
|Show all users|yes|no|
|
