Django REST Framework ile Görev Yöneticisi API’sı Oluşturma: Adım Adım Rehber
Merhaba! Bu rehberde, Django REST Framework kullanarak adım adım bir görev yöneticisi API’sı nasıl oluşturacağınızı öğreneceksiniz. Bu API, görevlerin oluşturulmasını, güncellenmesini, silinmesini ve listelenmesini sağlayacak. Öncelikle, gerekli paketleri kurmamız gerekiyor.
Gerekli Paketlerin Kurulumu
Projenize gerekli paketleri kurmak için aşağıdaki komutu kullanabilirsiniz:
pip install django djangorestframework
Bu komut Django ve Django REST Framework paketlerini kuracaktır. Ardından, Django projenizi oluşturabilirsiniz.
Django Projesinin Oluşturulması
Yeni bir Django projesi oluşturmak için terminalde şu komutu çalıştırın:
django-admin startproject task_manager
Ardından, projenin içine bir uygulama eklememiz gerekiyor. Bu uygulama, görevlerle ilgili tüm mantığı içerecektir.
Uygulama Oluşturma ve Modeller
Yeni bir uygulama oluşturmak için:
python manage.py startapp tasks
Şimdi, tasks/models.py dosyasına görev modelini tanımlayalım. Bu model, görevlerin özelliklerini (başlık, açıklama, tamamlanma durumu vb.) belirleyecektir. Örneğin:
from django.db import models
class Task(models.Model):
title = models.CharField(max_length=200)
description = models.TextField(blank=True)
completed = models.BooleanField(default=False)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
def __str__(self):
return self.title
Bu model, her görevin bir başlığı, isteğe bağlı bir açıklaması, tamamlanma durumu, oluşturulma ve güncellenme zamanını tutar. Sonrasında, bu modeli veritabanına göç ettirmeliyiz.
Veritabanı Göçü
Veritabanı göçü için aşağıdaki komutu kullanın:
python manage.py makemigrations tasks
python manage.py migrate
Serializer’ların Tanımlanması
Django REST Framework, verileri JSON formatına dönüştürmek için serializer’lar kullanır. tasks/serializers.py dosyasına bir serializer tanımlayalım:
from rest_framework import serializers
from .models import Task
class TaskSerializer(serializers.ModelSerializer):
class Meta:
model = Task
fields = ['id', 'title', 'description', 'completed']
Bu serializer, görev modelinin id, title, description ve completed alanlarını içerecektir. Sonraki adımda, ViewSet’leri oluşturacağız.
ViewSet’lerin Oluşturulması ve API Görünümlerinin Tanımlanması
ViewSet’ler, API görünümlerini oluşturmanın bir yoludur. tasks/views.py dosyasına bir ViewSet ekleyelim:
from rest_framework import viewsets
from .models import Task
from .serializers import TaskSerializer
class TaskViewSet(viewsets.ModelViewSet):
queryset = Task.objects.all()
serializer_class = TaskSerializer
Bu ViewSet, tüm görevleri görüntüler ve CRUD işlemlerini (oluşturma, okuma, güncelleme, silme) sağlar. Son adımda, URL’leri tanımlayacağız.
URL’lerin Tanımlanması
URL’leri tanımlamak için task_manager/urls.py dosyasını düzenleyelim:
from django.contrib import admin
from django.urls import path, include
from rest_framework import routers
from tasks import views
router = routers.DefaultRouter()
router.register(r'tasks', views.TaskViewSet)
urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include(router.urls)),
]
Bu, /api/tasks/ adresinde API’mızı kullanılabilir hale getirecektir. Artık API’nızı test edebilirsiniz.
API’nin Test Edilmesi
API’nızı Postman veya benzeri bir araç kullanarak test edebilirsiniz. Örneğin, yeni bir görev oluşturmak için bir POST isteği gönderebilirsiniz. Detaylı testler için Postman kullanmanızı şiddetle tavsiye ederim. Postman ile ilgili daha fazla bilgi için linke göz atabilirsiniz.
Bu adım adım rehber, Django REST Framework kullanarak basit bir görev yöneticisi API’sı oluşturmanıza yardımcı olacaktır. Daha karmaşık özellikler eklemek için, Django REST Framework dokümanlarına başvurabilirsiniz. Daha fazla bilgi için Django REST Framework Resmi Dokümanları sayfasını ziyaret edebilirsiniz. Kendi web sitemde de bu konuyla ilgili daha fazla makale bulabilirsiniz: fatihsoysal.com
#Etiketler
Django, REST Framework, API, Görev Yöneticisi, Python, Web Geliştirme, Programlama, Tutorial, Postman, ModelViewSet, Serializer, URL Routing
