מהו API

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

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

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

{"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. כותרת היא שורת מידע שנשלחת עם התשובה; הכותרת הזאת מודיעה לתוכנית איזה סוג נתונים היא קיבלה.

אתגר

קל

הוסיפו למנהל המשימות את נקודת הקצה הראשונה שלו:

תצוגה בשם stats שמחזירה JSON עם total, מספר המשימות, ועם done, מספר המשימות שהושלמו.
הנתיב "api/stats/", ששמו stats.

לחצו על Run, ואז פתחו את /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()})