diff --git a/API.md b/API.md new file mode 100644 index 0000000..8df5cff --- /dev/null +++ b/API.md @@ -0,0 +1,23 @@ +[domov](README.md) +# API dokumentacia + +## Timer API + +### Write Time Endpoint + +**Endpoint:** `GET /api/timer/write////` + +**Description:** Tento endpoint sluzi na zapis casu do databazy. Zaeoven vytvori +novy zaznam v tabulke `Lap` ak najde registraciu s danou kartou. Ak nieje ziadene ukopncene +kolo, tak vytovri nove a cas pouzije ako start. Ak najde neukoncene kolo, tak ho ukonci a +zapisuje cas ako end. + +**Parameters:** +- `timer_id` (string): identifikator casomiery, ktora odosiela request. (napr. 12345) +- `chip_id` (string): id karty, ktora bola nacitana. (napr. 222-222-222-222) +- `time` (string): cas v timestamp formate spolu s milisekundami. (napr. 1741169316.149847) + +**Example Request:** + +```bash +curl -X GET "http://your-domain/api/timer/write/12345/222-222-222-222/1741169316.149847/" \ No newline at end of file diff --git a/README.md b/README.md index e18f503..5197353 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ ## Description django app na secko +## Timer API +Otvorene api rozhranie s metodami pre citacky kariet. Viac info tu [Timer API](API.md) + ## Run potrebujes `.env` file alebo exportnut vsetky potrebne virtual environments. Tie pouzije docker compose pri startovani kontainerov diff --git a/src/kalskeborec/urls.py b/src/kalskeborec/urls.py index 4b5d805..1fedaf1 100644 --- a/src/kalskeborec/urls.py +++ b/src/kalskeborec/urls.py @@ -26,5 +26,5 @@ urlpatterns = [ path("", include("users.urls")), path("", include("core.urls")), path("events/", include("events.urls")), - path("timer/", include("timer.urls")), + path("api/timer/", include("timer.urls")), ] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT) + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)