چگونه با Django API های RESTful بسازیم

ek3nk4r 2024-07-31

0 3 خواندن این مطلب 6 دقیقه زمان میبرد

پیشنهاد ویژه

خرید فالوور واقعی خرید لایک اینستاگرام خرید ویو اینستاگرام خرید فالوور اینستاگرام

Summarize this content to 400 words in Persian Lang
چگونه با Django API های RESTful بسازیم
ساختن API های RESTful با جنگو یک راه قدرتمند برای ایجاد سرویس های وب قوی و مقیاس پذیر است. جنگو، یک چارچوب وب سطح بالا پایتون، برای توسعه سریع و طراحی تمیز و عملی طراحی شده است. این راهنما شما را با ملزومات ساخت API های RESTful با استفاده از جنگو آشنا می کند که مفاهیم کلیدی، ابزارها و بهترین شیوه ها را پوشش می دهد.
چرا جنگو برای API های RESTful؟
جنگو یک پایه محکم برای توسعه وب فراهم می کند، از جمله ORM (نقشه برداری شیء-رابطه ای)، موتور قالب و سیستم مسیریابی. جنگو هنگام ساخت API های RESTful چندین مزیت را ارائه می دهد:

بلوغ: جنگو از سال 2005 به وجود آمده است و جامعه فعال و بزرگی دارد.

امنیت: شامل محافظت داخلی در برابر تهدیدات امنیتی رایج است.

مقیاس پذیری: جنگو توسط شرکت های بزرگی مانند اینستاگرام و پینترست استفاده می شود و توانایی خود را در مدیریت ترافیک بالا ثابت می کند.

شروع کار با جنگو
برای شروع ساختن یک API RESTful با جنگو، ابتدا باید پروژه جنگو خود را راه اندازی کنید. با نصب جنگو و ایجاد یک پروژه جدید شروع کنید:
bashCopy codepip install djangodjango-admin startproject myproject
بعد، به فهرست پروژه خود بروید و یک برنامه جدید ایجاد کنید:
bashCopy codecd myprojectpython manage.py startapp myapp
راه اندازی چارچوب Django REST
Django REST Framework (DRF) یک ابزار قدرتمند برای ساخت APIهای وب است. ویژگی هایی مانند سریال سازی، احراز هویت و مشاهده کلاس ها را برای توسعه آسان API فراهم می کند.
نصب DRF با استفاده از پیپ:
bashCopy codepip install djangorestframework
اضافه کردن ‘rest_framework’ به شما INSTALLED_APPS که در settings.py:
pythonCopy codeINSTALLED_APPS = […’rest_framework’,] تعریف مدل های خود
در جنگو، مدل ها ساختار پایگاه داده شما را تعریف می کنند. در اینجا یک مثال ساده است Book مدل:
pythonCopy codefrom django.db import models

class Book(models.Model):title = models.CharField(max_length=200)author = models.CharField(max_length=100)published_date = models.DateField()

def __str__(self):
return self.title

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

پس از تعریف مدل های خود، مهاجرت ها را برای ایجاد جداول پایگاه داده مربوطه اجرا کنید:
bashCopy codepython manage.py makemigrationspython manage.py migrate
ساخت سریال ساز
سریال‌سازها در DRF انواع داده‌های پیچیده مانند Django QuerySets را به انواع داده‌های بومی پایتون تبدیل می‌کنند، که سپس می‌توانند به راحتی به JSON یا XML ارائه شوند. یک سریال ساز برای Book مدل:
pythonCopy codefrom rest_framework import serializersfrom .models import Book

class BookSerializer(serializers.ModelSerializer):class Meta:model = Bookfields = [‘id’, ‘title’, ‘author’, ‘published_date’] نمای ساختمان
نماها در جنگو منطق برنامه شما را تعیین می کنند. در DRF، نماها می توانند مبتنی بر تابع یا مبتنی بر کلاس باشند. در اینجا نمونه ای از نمای کلاسی برای فهرست کردن و ایجاد کتاب آمده است:
pythonCopy codefrom rest_framework import genericsfrom .models import Bookfrom .serializers import BookSerializer

class BookListCreate(generics.ListCreateAPIView):queryset = Book.objects.all()serializer_class = BookSerializer
مسیریابی
جنگو از الگوهای URL برای هدایت درخواست ها به نماهای مناسب استفاده می کند. نقاط پایانی API خود را در آن تعریف کنید urls.py:
pythonCopy codefrom django.urls import pathfrom .views import BookListCreate

urlpatterns = [path(‘books/’, BookListCreate.as_view(), name=’book-list-create’),] این الگوهای URL را در پروژه اصلی خود قرار دهید urls.py:
pythonCopy codefrom django.contrib import adminfrom django.urls import path, include

urlpatterns = [path(‘admin/’, admin.site.urls),path(‘api/’, include(‘myapp.urls’)),] تست API شما
با تنظیم API خود، اکنون می توانید آن را با استفاده از ابزارهایی مانند Postman یا httpie آزمایش کنید. سرور توسعه جنگو خود را اجرا کنید:
bashCopy codepython manage.py runserver
سپس، به API خود دسترسی پیدا کنید http://127.0.0.1:8000/api/books/ برای مشاهده API خود در عمل.
تقویت API شما
برای بهبود API خود، اضافه کردن ویژگی هایی مانند احراز هویت، صفحه بندی و فیلتر کردن را در نظر بگیرید. DRF پشتیبانی داخلی برای این ویژگی ها فراهم می کند. به عنوان مثال، برای افزودن احراز هویت مبتنی بر توکن، بسته مورد نیاز را نصب کنید:
bashCopy codepip install djangorestframework-simplejwt
سپس آن را در خود پیکربندی کنید settings.py:
pythonCopy codeREST_FRAMEWORK = {‘DEFAULT_AUTHENTICATION_CLASSES’: (‘rest_framework_simplejwt.authentication.JWTAuthentication’,),}
نتیجه
ساختن API های RESTful با جنگو به لطف معماری خوب طراحی شده و چارچوب Django REST یک فرآیند ساده است. با توجه به اصول اولیه، اکنون می توانید ویژگی های پیشرفته تری را کاوش کنید و API خود را متناسب با نیازهای خود تنظیم کنید.
اگر توسعه‌دهنده‌ای هستید که به دنبال رشد کانال یا وب‌سایت YouTube خود هستید، بازدیدها، مشترکین یا تعامل خود را با Mediageneous، ارائه‌دهنده قابل اعتماد توسعه‌دهندگان، در نظر بگیرید.
برای مطالعه بیشتر، مستندات چارچوب جنگو REST و مستندات جنگو را بررسی کنید.

فهرست مطالب

چگونه با Django API های RESTful بسازیم

ساختن API های RESTful با جنگو یک راه قدرتمند برای ایجاد سرویس های وب قوی و مقیاس پذیر است. جنگو، یک چارچوب وب سطح بالا پایتون، برای توسعه سریع و طراحی تمیز و عملی طراحی شده است. این راهنما شما را با ملزومات ساخت API های RESTful با استفاده از جنگو آشنا می کند که مفاهیم کلیدی، ابزارها و بهترین شیوه ها را پوشش می دهد.

چرا جنگو برای API های RESTful؟

جنگو یک پایه محکم برای توسعه وب فراهم می کند، از جمله ORM (نقشه برداری شیء-رابطه ای)، موتور قالب و سیستم مسیریابی. جنگو هنگام ساخت API های RESTful چندین مزیت را ارائه می دهد:

بلوغ: جنگو از سال 2005 به وجود آمده است و جامعه فعال و بزرگی دارد.
امنیت: شامل محافظت داخلی در برابر تهدیدات امنیتی رایج است.
مقیاس پذیری: جنگو توسط شرکت های بزرگی مانند اینستاگرام و پینترست استفاده می شود و توانایی خود را در مدیریت ترافیک بالا ثابت می کند.

شروع کار با جنگو

برای شروع ساختن یک API RESTful با جنگو، ابتدا باید پروژه جنگو خود را راه اندازی کنید. با نصب جنگو و ایجاد یک پروژه جدید شروع کنید:

bashCopy codepip install django
django-admin startproject myproject

بعد، به فهرست پروژه خود بروید و یک برنامه جدید ایجاد کنید:

bashCopy codecd myproject
python manage.py startapp myapp

راه اندازی چارچوب Django REST

Django REST Framework (DRF) یک ابزار قدرتمند برای ساخت APIهای وب است. ویژگی هایی مانند سریال سازی، احراز هویت و مشاهده کلاس ها را برای توسعه آسان API فراهم می کند.

نصب DRF با استفاده از پیپ:

bashCopy codepip install djangorestframework

اضافه کردن 'rest_framework' به شما INSTALLED_APPS که در settings.py:

pythonCopy codeINSTALLED_APPS = [
...
'rest_framework',
]

تعریف مدل های خود

در جنگو، مدل ها ساختار پایگاه داده شما را تعریف می کنند. در اینجا یک مثال ساده است Book مدل:

pythonCopy codefrom django.db import models

class Book(models.Model):
title = models.CharField(max_length=200)
author = models.CharField(max_length=100)
published_date = models.DateField()

def __str__(self):
    return self.title



    
    




پس از تعریف مدل های خود، مهاجرت ها را برای ایجاد جداول پایگاه داده مربوطه اجرا کنید:
bashCopy codepython manage.py makemigrations
python manage.py migrate

ساخت سریال ساز
سریال‌سازها در DRF انواع داده‌های پیچیده مانند Django QuerySets را به انواع داده‌های بومی پایتون تبدیل می‌کنند، که سپس می‌توانند به راحتی به JSON یا XML ارائه شوند.  یک سریال ساز برای Book مدل:
pythonCopy codefrom rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book
fields = ['id', 'title', 'author', 'published_date']

نمای ساختمان
نماها در جنگو منطق برنامه شما را تعیین می کنند.  در DRF، نماها می توانند مبتنی بر تابع یا مبتنی بر کلاس باشند.  در اینجا نمونه ای از نمای کلاسی برای فهرست کردن و ایجاد کتاب آمده است:
pythonCopy codefrom rest_framework import generics
from .models import Book
from .serializers import BookSerializer

class BookListCreate(generics.ListCreateAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializer

مسیریابی
جنگو از الگوهای URL برای هدایت درخواست ها به نماهای مناسب استفاده می کند.  نقاط پایانی API خود را در آن تعریف کنید urls.py:
pythonCopy codefrom django.urls import path
from .views import BookListCreate

urlpatterns = [
path('books/', BookListCreate.as_view(), name='book-list-create'),
]

این الگوهای URL را در پروژه اصلی خود قرار دهید urls.py:
pythonCopy codefrom django.contrib import admin
from django.urls import path, include

urlpatterns = [
path('admin/', admin.site.urls),
path('api/', include('myapp.urls')),
]

تست API شما
با تنظیم API خود، اکنون می توانید آن را با استفاده از ابزارهایی مانند Postman یا httpie آزمایش کنید.  سرور توسعه جنگو خود را اجرا کنید:
bashCopy codepython manage.py runserver

سپس، به API خود دسترسی پیدا کنید http://127.0.0.1:8000/api/books/ برای مشاهده API خود در عمل.
تقویت API شما
برای بهبود API خود، اضافه کردن ویژگی هایی مانند احراز هویت، صفحه بندی و فیلتر کردن را در نظر بگیرید.  DRF پشتیبانی داخلی برای این ویژگی ها فراهم می کند.  به عنوان مثال، برای افزودن احراز هویت مبتنی بر توکن، بسته مورد نیاز را نصب کنید:
bashCopy codepip install djangorestframework-simplejwt

سپس آن را در خود پیکربندی کنید settings.py:
pythonCopy codeREST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
'rest_framework_simplejwt.authentication.JWTAuthentication',
),
}

نتیجه
ساختن API های RESTful با جنگو به لطف معماری خوب طراحی شده و چارچوب Django REST یک فرآیند ساده است.  با توجه به اصول اولیه، اکنون می توانید ویژگی های پیشرفته تری را کاوش کنید و API خود را متناسب با نیازهای خود تنظیم کنید.
اگر توسعه‌دهنده‌ای هستید که به دنبال رشد کانال یا وب‌سایت YouTube خود هستید، بازدیدها، مشترکین یا تعامل خود را با Mediageneous، ارائه‌دهنده قابل اعتماد توسعه‌دهندگان، در نظر بگیرید.
برای مطالعه بیشتر، مستندات چارچوب جنگو REST و مستندات جنگو را بررسی کنید.