Przykładowy projekt demonstracyjny mający na celu przedstawienie prostego serwera API (REST) stworzonego w Pythonie przy użyciu frameworka Flask. Aplikacja pozwala na zarządzanie użytkownikami poprzez operacje CRUD.
Caution
Uwaga: Ten projekt jest demonstracją i nie powinien być używany w środowisku produkcyjnym
- Rejestracja nowego użytkownika
- Pobieranie listy wszystkich użytkowników
- Pobieranie szczegółowych danych pojedynczego użytkownika
- Aktualizacja hasła użytkownika
- Usuwanie konta użytkownika
server.py- serwer API z endpointami i backendemclient.py- klient konsolowy do testowania APIusers.json- plik do przechowywania danych o użytkownikach
Note
Wymagania:
- Python 3.7+
- pip (menedżer pakietów)
Konfiguracja środowiska wirtualnego
- Sklonuj lub pobierz repozytorium
- Otwórz terminal/wiersz poleceń i wybierz mejsce docelowe projektu
cd C:\{lokalizacja projektu}
- Stwórz wirtualne środowisko
python -m venv env
- Aktywuj wirtualne środowisko
env\Scripts\activate
- Zainstaluj wymagane biblioteki
pip install -r requirements.txt
<LUB>
py -m pip install -r requirements.txt
Serwer
py server.py
Klient
py client.py
Po uruchomieniu klienta pojawi się menu z opcjami wymienionymi w funkcjach aplikacji
| Metoda | Endpoint | Opis |
|---|---|---|
| POST | /register | Rejestracja nowego użytkownika |
| GET | /users | Pobieranie listy wszystkich użytkowników |
| GET | /users/{user_id} | Pobieranie danych pojedynczego użytkownika |
| PUT | /users/{user_id} | Aktualizacja hasła użytkownika |
| DELETE | /users/{user_id} | Usunięcie konta użytkownika |
API zawiera obsługę błędów z wykorzystaniem niestandardowej klasy ApiError, która zwraca odpowiedzi w formacie JSON:
- Kod statusu HTTP
- Komunikat błędu
- Opcjonalnie dodatkowe szczegóły
Możliwe poszerzenie projektu o:
- hashowanie haseł
- uwierzytelnianie JWT
- utworzenie bazy danych (SQL lub noSQL)