Version: 1.0.0
🛠 Technologien
- C#, ASP.NET Core, Entity Framework Core, Swagger
📌 Projektbeschreibung
Die TodoAPI ist eine schlanke und gut dokumentierte RESTful API zur Verwaltung von Aufgaben (ToDos) und Benutzern. Sie wurde mit ASP.NET Core Web API entwickelt und folgt modernen API-Entwicklungsstandards, um eine skalierbare, erweiterbare und leicht verständliche Lösung bereitzustellen.
Dank der integrierten Swagger UI kann die API direkt im Browser getestet werden. Entity Framework Core ermöglicht eine einfache In-Memory-Datenbank, die sich leicht durch eine persistente Datenbank erweitern lässt.
🚀 Features & Funktionen
- ✅ Aufgabenverwaltung: CRUD-Operationen (Erstellen, Lesen, Aktualisieren, Löschen)
- ✅ Benutzerverwaltung: Möglichkeit, Benutzer zu erstellen und zu verwalten
- ✅ Datenbank mit Entity Framework Core: Nutzung einer In-Memory-Datenbank für schnelle Tests
- ✅ REST-konforme API-Struktur: Klare Endpunkte mit GET, POST, PUT, DELETE
- ✅ Detaillierte API-Dokumentation mit Swagger: Automatisch generierte Dokumentation für einfache Nutzung
📌 API-Endpunkte
📝 Aufgabenverwaltung (ToDos)
| Methode | Endpoint | Beschreibung |
|---|---|---|
| GET | /api/Todo | Alle Aufgaben abrufen |
| GET | /api/Todo/{id} | Eine bestimmte Aufgabe abrufen |
| POST | /api/Todo | Neue Aufgabe erstellen |
| PUT | /api/Todo/{id} | Eine bestehende Aufgabe aktualisieren |
| DELETE | /api/Todo/{id} | Aufgabe löschen |
👥 Benutzerverwaltung
| Methode | Endpoint | Beschreibung |
|---|---|---|
| GET | /api/User | Alle Benutzer abrufen |
| POST | /api/User | Neuen Benutzer erstellen |
📌 Beispielanfrage & JSON-Response
Neue Aufgabe erstellen (POST /api/Todo)
📌 Anfrage:
{ "title": "Einkaufen", "description": "Milch, Brot, Eier", "priority": "2", "dueTime": "2024-02-01T18:30:00Z"}📌 Antwort (201 Created):
{ "id": "1", "title": "Einkaufen", "description": "Milch, Brot, Eier", "priority": "2", "dueTime": "2024-02-01T18:30:00Z", "createdAt": "2024-01-28T12:00:00Z"}🔮 Erweiterungsmöglichkeiten
Die TodoAPI dient als Beispiel und ist so konzipiert, dass sie einfach erweitert werden kann.
Mögliche Erweiterungen sind:
- 🛡 JWT-Authentifizierung für Benutzerverwaltung
- 🗄 Datenbank-Anbindung (z. B. PostgreSQL, MySQL) für persistente Speicherung
- ⏰ Erinnerungsfunktionen (z. B. E-Mail-Benachrichtigungen)
- 🌐 Frontend-Integration mit Angular, React oder Vue.js
📜 Lizenz: Open Source, veröffentlicht unter der MIT-Lizenz
🔗 GitHub Repository: https://github.com/MariusH-Dev/todoApi
