Menu
CoddyTech

المشروع: الأولويات

جزء من قسم واجهات API بصيغة JSON في رحلة Django على Coddy. الدرس 15 من 19.

حان الوقت لإضافة ميزة بنفسك. لكل مهمة priority: low أو normal أو high. ينبغي أن تتيح واجهة API للبرامج طلب أولوية واحدة، وأن تمنع أي شخص من اختراع أولوية رابعة.

لديك كل ما تحتاج إليه بالفعل: request.GET.get() لتطبيق عامل تصفية، ومجموعة QuerySet يمكنك تصفيتها أكثر من مرة، وقاموس errors الذي يعيد استجابة 400.

القيم المسموح بها موجودة في النموذج. Task.Priority فئة TextChoices، وTask.Priority.values هي القائمة ["low", "normal", "high"]. يعني التحقق من القيم باستخدامها قبول أي أولوية تُضاف إلى النموذج لاحقًا من دون الحاجة إلى تغيير العرض.

challenge icon

التحدي

متوسط

أضف الأولويات إلى واجهة API:

  • يعرض /api/tasks/?priority=high المهام ذات الأولوية العالية فقط، ويعمل مع ?done=: ?priority=high&done=false.
  • يؤدي طلب POST بأولوية غير low أو normal أو high إلى استجابة 400 تتضمن خطأ تحت "priority"، ولا يحفظ أي شيء.
  • عدم تحديد أولوية يعني استخدام normal.

اضغط على Run: تعرض المعاينة المهمة الوحيدة ذات الأولوية العالية.

جرّب بنفسك

import json

from django.http import HttpResponse, JsonResponse
from django.shortcuts import get_object_or_404, render
from django.utils.decorators import method_decorator
from django.views import View
from django.views.decorators.csrf import csrf_exempt
from django.views.decorators.http import require_GET, require_http_methods

from .models import Task


def task_to_dict(task):
    return {
        "id": task.id,
        "title": task.title,
        "done": task.done,
        "priority": task.priority,
    }


def home(request):
    return render(request, "tasks/home.html")


def task_page(request):
    return render(request, "tasks/list.html", {"tasks": Task.objects.all()})


def task_row(request, pk):
    task = get_object_or_404(Task, pk=pk)
    return render(request, "tasks/list.html#task-row", {"task": task})


@require_GET
def stats(request):
    total = Task.objects.count()
    done = Task.objects.filter(done=True).count()
    data = {
        "total": total,
        "done": done,
        "open": total - done,
    }
    return JsonResponse(data)


@csrf_exempt
@require_http_methods(["GET", "POST"])
def task_list(request):
    if request.method == "POST":
        try:
            data = json.loads(request.body)
        except json.JSONDecodeError:
            return JsonResponse({"error": "The body is not valid JSON."}, status=400)
        errors = {}
        title = data.get("title", "").strip()
        if not title:
            errors["title"] = "This field is required."
        if errors:
            return JsonResponse({"errors": errors}, status=400)
        task = Task.objects.create(
            title=title,
            priority=data.get("priority", "normal"),
        )
        return JsonResponse(task_to_dict(task), status=201)
    tasks = Task.objects.all()
    done = request.GET.get("done")
    if done == "true":
        tasks = tasks.filter(done=True)
    elif done == "false":
        tasks = tasks.filter(done=False)
    return JsonResponse([task_to_dict(task) for task in tasks], safe=False)


def not_found():
    return JsonResponse({"error": "Task not found"}, status=404)


@method_decorator(csrf_exempt, name="dispatch")
class TaskDetail(View):
    def get(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        return JsonResponse(task_to_dict(task))

    def patch(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        data = json.loads(request.body)
        if "title" in data:
            task.title = data["title"]
        if "done" in data:
            task.done = data["done"]
        task.save()
        return JsonResponse(task_to_dict(task))

    def delete(self, request, pk):
        task = Task.objects.filter(pk=pk).first()
        if task is None:
            return not_found()
        task.delete()
        return HttpResponse(status=204)

جميع دروس واجهات API بصيغة JSON

تدرّب بنفسك: Playground لـ Django