TASKFLOW API - Kapsamlı Dokümantasyon Seti

Bu proje, yönergede belirtilen zorunlu gereksinimlerin yanı sıra; gelişmiş filtreleme, veri doğrulama (validation) ve raporlama servisleri gibi ileri seviye API özelliklerini içermektedir.

Geliştirici: Zeynep Sude Bayram

---

1. Kurulum Notu (README) & Kullanım Kılavuzu

Projeyi yerel ortamınızda (localhost) çalıştırmak ve entegre etmek için aşağıdaki adımları izleyebilirsiniz.

Gereksinimler: Bilgisayarınızda Node.js yüklü olmalıdır.

Adım Adım Kurulum:

1. Sıkıştırılmış proje klasörünü (ZIP) çıkartın.
2. Terminal veya komut satırı üzerinden taskflow-api dizinine gidin.
3. Gerekli bağımlılıkları (Express.js) yüklemek için şu komutu çalıştırın: npm install
4. Kurulum tamamlandıktan sonra sunucuyu başlatmak için: node server.js
5. Terminalde Sunucu http://localhost:3000 adresinde dinleniyor... mesajını gördüğünüzde sistem kullanıma hazırdır.
6. İstemci uygulamanızdan (veya Postman üzerinden) http://localhost:3000 adresine HTTP istekleri atarak API'yi kullanmaya başlayabilirsiniz.

---

2. API Dokümantasyonu

Sistemdeki tüm endpoint'ler (uç noktalar), beklenen parametreler ve yanıtlar aşağıda listelenmiştir.

Görev Yönetimi (CRUD) ve Filtreleme

• GET /tasks
  • İşlev: Sistemdeki tüm görevleri listeler.
  • Parametreler (Query): ?status=... (Duruma göre filtreler), ?priority=... (Önceliğe göre filtreler).
  • Başarılı Yanıt: 200 OK (Görev nesnelerinden oluşan JSON dizisi).
• GET /tasks/:id
  • İşlev: Belirtilen ID'ye sahip görevin detaylarını getirir.
• POST /tasks
  • İşlev: Yeni görev oluşturur. Validation katmanından geçer.
  • Beklenen Body (JSON): title, description, assignee, priority (Tümü zorunludur).
  • Başarılı Yanıt: 201 Created ve oluşturulan görev verisi.
• PUT /tasks/:id
  • İşlev: Mevcut bir görevi günceller. Validation katmanından geçer.
  • Başarılı Yanıt: 200 OK ve güncellenen görev verisi.
• DELETE /tasks/:id
  • İşlev: Belirtilen görevi sistemden kalıcı olarak siler.
  • Başarılı Yanıt: 200 OK ve "Görev başarıyla silindi" mesajı.

Raporlama Servisleri

• GET /reports/completed: Tamamlanan görev sayısını döndürür.
• GET /reports/pending: Bekleyen görev sayısını döndürür.
• GET /reports/summary: Sistemdeki toplam ve tamamlanan görev özetini döndürür ({"total": X, "completed": Y}).

---

3. Test Dokümantasyonu (Örnek Senaryolar)

Postman üzerinden gerçekleştirilen ve ekran görüntüleri ile kanıtlanan test senaryoları şunlardır:

• Senaryo 1: Validation Middleware Testi (Hata Kontrolü)
  • Eylem: Eksik JSON verisi (sadece title ve description) ile POST isteği atılır.
  • Beklenen ve Alınan Sonuç: 400 Bad Request. Sistem, eksik alanları belirten net bir hata mesajı döndürür. Veri bütünlüğü korunur.
• Senaryo 2: Başarılı Veri Ekleme (POST)
  • Eylem: Tüm zorunlu alanları içeren geçerli bir JSON formatı ile POST isteği atılır.
  • Beklenen ve Alınan Sonuç: 201 Created. Sistem görevi kaydeder ve yanıt olarak döndürür.
• Senaryo 3: Gelişmiş Filtreleme (GET)
  • Eylem: /tasks?status=Tamamlandı adresine GET isteği atılır.
  • Beklenen ve Alınan Sonuç: 200 OK. Sistem yalnızca durumu "Tamamlandı" olan görevleri filtreleyip listeler.
• Senaryo 4: Raporlama ve Özet (GET)
  • Eylem: /reports/summary adresine GET isteği atılır.
  • Beklenen ve Alınan Sonuç: 200 OK. Toplam kayıtlı görev ve tamamlanmış görev sayıları istatistiksel olarak döner.# taskflow-api