מהו API

חלק מהיחידה ממשקי API של JSON במסלול ה-Django של Coddy. שיעור 1 מתוך 19.

התצוגות שכתבת עד כה מחזירות דפים שאנשים יכולים לקרוא. API (ממשק תכנות יישומים) מחזיר נתונים עבור תוכנות. אפליקציה בטלפון, סקריפט או JavaScript בדף מבקשים כתובת URL ומקבלים נתונים במקום HTML.

הנתונים האלה הם בדרך כלל JSON, טקסט שנראה כמו מילונים ורשימות של Python, עם מירכאות כפולות ועם true, false ו-null במקום True, False ו-None של Python:

{"title": "Buy milk", "done": false, "due": null}

Django ממירה מילון לתגובת JSON באמצעות JsonResponse:

from django.http import JsonResponse


def hello(request):
    return JsonResponse({"message": "Hi", "ready": True})

היא כותבת את JSON ומגדירה את הכותרת Content-Type לערך application/json. כותרת היא שורת מידע שנשלחת יחד עם התגובה; הכותרת הזאת מציינת לתוכנה איזה סוג נתונים היא קיבלה.

אתגר

קל

הוסיפו למנהל המשימות את נקודת הקצה הראשונה שלו, כתובת URL שמחזירה מספרים במקום דף.

ב־tasks/views.py, ייבאו את JsonResponse מתוך django.http והוסיפו תצוגה בשם stats שמחזירה JSON: total, מספר המשימות, ו־done, מספר המשימות שהושלמו.
ב־tasks/urls.py, הוסיפו את הנתיב "api/stats/" בשם stats.

לחצו על «הפעלה»: התצוגה המקדימה נפתחת ב־/api/stats/ ומציגה {"total": 3, "done": 1}.

נסו בעצמכם

from django.shortcuts import render

from .models import Task


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