Úkol 6 - RESTful API Server

Maximální počet bodů	10 bodů
Způsob komunikace s aplikací	Parametry předané při spuštění
Způsob testování aplikace	Na základě HTTP komunikace

---

📝 Zadání úkolu

Naprogramujte RESTful API Server pomocí frameworku Spring Boot, který bude poskytovat služby pro správu seznamu uživatelů. Tato aplikace bude spuštěna na portu 8080 a bude využívat http připojení. Vaše aplikace bude podporovat následující operace:

1. Získání seznamu uživatelů: API endpoint pro získání seznamu všech uživatelů v systému.
2. Získání jednoho uživatele: API endpoint pro získání jednoho konkrétního uživatele podle jeho id. Pokud není uživatel nalezen, tak navrátí HTTP status kód 404 Not Found.
3. Vytvoření nového uživatele: API endpoint pro vytvoření nového uživatele v systému. Endpoint bude validovat zadané data (email a telefoní číslo). Při úspěšném vytvoření navratí HTTP status kód 201 spolu s nově vytvořeným uživatelem ve formatu JSON (třida uživatele). Pokud tyto data nebudou splňovat požadovaný formát, nebude uživatel v systému vytvořen a server navrátí HTTP status kód 400 Bad Request.
4. Aktualizace existujícího uživatele: API endpoint pro aktualizaci informací o existujícím uživateli v systému. Pokud takový uživatel není nalezen, tak navrátí HTTP status kód 404 Not Found. Pokud dojde k jiné chybě, navrátí HTTP status kód 400.
5. Smazání uživatele: API endpoint pro smazání existujícího uživatele ze systému. Pokud dojde k nějaké chybě, navrátí HTTP status kód 400.
6. Smazání všech uživatelů: API endpoint, který odstraní všechny uživatele z databáze. Pokud dojde k nějaké chybě, navrátí HTTP status kód 400.

Typ požadavku	Název endpointu	URL adresa endpointu	Předávané parametry	Formát odpovědi
GET	Získání seznamu uživatelů	/users	N/A	JSON
GET	Získání informací o jednom uživateli	/getUser	ID uživatele	JSON
POST	Vytvoření nového uživatele	/createUser	Data nového uživatele	JSON
PUT	Aktualizace existujícího uživatele	/editUser	ID uživatele, Data aktualizovaného uživatele	JSON
DELETE	Smazání uživatele	/deleteUser	ID uživatele	JSON
DELETE	Smazání všech uživatelů	/deleteAll	N/A	JSON

Poznámka: Funkcionalitu vaší aplikace můžete manuálně otestovat pomocí nástroje cURL. https://curl.se/ Pro získání všech uživatelů můžete použít tento příkaz: curl -X GET http://localhost:8080/users -H 'Content-Type: application/json'

Datová struktura uživatele

Do této třídy budou v aplikaci ukládány data o uživateli. Bude potřeba dokončit její implementaci a i vhodně zvolit anotace, aby ji bylo možné ukládat do databáze prostřednictvím JPA repozitáře.

package utb.fai.RESTAPIServer;

class MyUser {

    private Long id;
    private String name;
    private String email;
    private String phoneNumber;

    public User() {}

    public User(String name, String email, String phoneNumber) {
        this.name = name;
        this.email = email;
        this.phoneNumber = phoneNumber;
    }
    
    public boolean isUserDataValid() {
        // Add your validation logic here (e.g., email and phone number format
        // validation)
        return true;
    }
    
    // TODO: Getters and setters
}

Pro ukládání uživatelských dat použijte libovolný volně dostupný databázový systém (např. MySQL, PostgreSQL, H2, MongoDB atd.), který bude vaše aplikace využívat. Můžete využít například následující službu, která nabízí free hosting databází: https://aiven.io/

Přístup k vaší databázi bude třeba nakonfigurovat v souboru application.properties, který se nachází ve složce src/main/resources.

Základní kostra programu se nachází v tomto repozitáři. Vaším úkolem bude implementovat všechny výše zmíněné endpointy.

Poznámka: Implementace a struktura kódu aplikace je libovolná a je zcela na vás, jak tento problém vyřešíte. Je však důležité, aby aplikace splňovala zadané požadavky.

---

🏆 Způsob hodnocení

Vaše implementace bude hodnocena na základě chování aplikace při testování různých scénářů. Automatizovaný testovací nástroj bude předávat vaší aplikaci různé parametry, včetně platných a neplatných, aby otestoval její chování za různých podmínek. V případě testování síťové komunikace mezi více klienty, testovací nástroj bude vytvářet virtuální klienty/servery za účelem ověření funkcionality.

Výsledné hodnocení bude záviset na celkovém počtu úspěšných testovacích případů. Počet bodů získaných z úlohy bude tedy záviset na celkové úspěšnosti při testování. Váš výsledný počet bodů bude určen následujícím vzorcem.

VP = MB * (UT / CPT)

Popis symbolů:

• VP: Výsledný počet bodů.
• MB: Maximální počet bodů pro danou úlohu.
• UT: Počet úspěšných testovacích případů.
• CPT: Celkový počet testovacích případů.

⚙️ Jak spustit automatizované hodnocení lokálně na svém počítači?

Automatizované hodnocení můžete spustit lokálně za účelem ověření funkčnosti vaší aplikace. K tomu slouží předpřipravený skript, který je dostupný v repozitáři tohoto úkolu. Výsledný report testování se bude nacházet v souboru test_report.html.

Pro uživatele systému Linux:

Spusťte skript s názvem run_local_test.sh.

Pro uživatele systému Windows:

Spusťte skript s názvem run_local_test.bat.