ما هي 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()})