REST API vytvořené pomocí frameworku FastAPI na správu a archivaci studenstkých prací SOČ
- Účastníci (participants) – jméno, škola, kontakt, ročník, obor
- Práce (works) – název, obor, anotace, vedoucí, škola, rok, účastník
- Výsledky (results) – umístění a postup do dalšího kola
- Vyhledávání studentských prací podle oboru, roku a názvu
- Evidenci účastníků a jejich prací
- Zobrazení výsledků soutěže
- Export prací do CSV
| Endpoint | Metoda | Popis |
|---|---|---|
/ |
GET | Ověření funkčnosti API |
/api |
- | Swagger dokumentace (OpenAPI) |
/works |
GET | Vrátí seznam prací (možno filtrovat podle oboru, roku, klíčového slova) |
/works |
POST | Přidá novou práci |
/works/{id} |
DELETE | Smaže práci podle ID |
/participants |
GET | Vrátí seznam účastníků |
/participants |
POST | Přidá nového účastníka |
/results |
GET | Vrátí seznam výsledků soutěže |
/export/csv |
GET | Export všech prací do CSV souboru |
- Python 3.10+
- FastAPI – webový framework
- Uvicorn – ASGI server pro běh FastAPI
v Powershellu navigujte do vámi vybrané složky a spusťte příkaz:
git clone https://github.com/houdcat/SOC-API.git
Navigujte do složky a otevřete main.py v PyCharm.
V PyCharm terminálu spusťte příkazy:
pip install -r requirements.txt
uvicorn main:app --reload
Na adrese http://127.0.0.1:8000/api by měla být dokumentace RestAPI