تغییرات اخیر

در اینجا اطلاعیه‌ها، نسخه‌ها و تغییرات جدید لیارا فهرست می‌شوند.

    آموزش ساخت RESTful API با فریم‌ورک Django REST

    آموزش ساخت restful api با فریم‌ورک django rest

    فریم‌ورک Django REST ابزاری برای سهولت ساخت RESTful APIها در برنامه‌های Django است و از ویژگی‌های این فریم‌ورک می‌توانیم به امنیت و قابلیت‌های پیشرفته‌ای مانند serializerها اشاره داشته باشیم که برای انتقال داده‌ها استفاده می‌شوند.

    داده‌هایی که در این سیستم انتقال داده می‌شوند از نوع JSON یا XML خواهند بود و این امکان را در اختیار ما می‌دهند تا برنامه‌های انعطاف‌پذیری را توسعه دهیم که فرانت‌اند آن‌ها با استفاده از کتابخانه‌ها و فریم‌ورک‌های برنامه‌نویسی‌ای مانند React، Vue و Angular ساخته می‌شود.

    پیش نیازهای ساخت API با فریم‌ورک Django REST

    قبل از شروع توسعه‌ی API با فریم‌ورک Django REST مراحل دیگری وجود دارند که در ادامه به آن‌ها خواهیم پرداخت. در مرحله‌ی اول توصیه می‌شود یک محیط مجازی قبل از شروع هر پروژه‌ای با زبان Python راه‌اندازی کرده باشید:

    python3 -m venv restful

    همچنین می‌توانید با مطالعه‌ی مقاله‌ی آموزش نصب و استفاده از Virtual environment در Python اطلاعات بیشتری از محیط مجازی در زبان Python کسب کنید.

    در قدم بعد بایستی محیط مجازی که ساخته بودیم را فعال کنیم و ما به‌دلیل اینکه در سیستم‌عامل ویندوز مشغول به توسعه‌ی این پروژه هستیم با فراخوانی فایل actiavte.bat محیط مجازی ما فعال خواهد شد:

    restful\Scripts\activate.bat

    سپس با دستور زیر به پوشه‌ی محیط مجازی خود وارد می‌شویم:

    cd restful

    پروژه فعلی ما به این صورت است که می‌خواهیم با فریم‌ورک Django REST در کنار فریم‌ورک Django به توسعه‌ی RESTful APIهایی بپردازیم که یک تقویم رویداد را مدیریت خواهند کرد، بنابراین فریم‌ورک‌های مورد نیازمان را با استفاده از دستور pip install نصب خواهیم کرد:

    pip install django
    pip install djangorestframework

    همان‌طور که گفتیم فریم‌ورک اصلی ما Django است بنابراین اگر هنوز با این فریم‌ورک آشنا نشده‌اید توصیه می‌شود مقاله‌ی آموزش مقدماتی فریم‌ورک Django را مطالعه کنید.

    ساخت پروژه و برنامه‌ی Django

    پس از نصب فریم‌ورک‌ Django برای ادامه‌ی روند توسعه به یک پروژه و یک برنامه‌ی Django نیاز خواهیم داشت بنابراین با دستور:

    django-admin startproject djangoproject

    یک پروژه‌ی با نام djangoproject خواهیم ساخت و سپس با دستور cd djangoproject وارد پوشه‌ی این پروژه می‌شویم تا بتوانیم با اجرای دستور:

    python manage.py startapp events

    برنامه‌ای با نام events بسازیم.

    پیکربندی تنظیمات پروژه‌‌ی Django

    پروژه را با یک ویرایشگر کد باز کنید و در فایل settings.py، فریم‌ورک Django REST و نام برنامه‌تان را در بخش INSTALLED_APPS به‌صورت زیر اضافه کنید:

    INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        'rest_framework',
        'events'
    ]

    در این آموزش نام برنامه‌ی ما events است اما توجه داشته باشید که اگر نام متفاوتی را برای برنامه‌ی خود در نظر گرفته‌اید، نام برنامه‌ی خودتان را به‌جای 'events' وارد کنید.

    پیکربندی Model در Django

    در معماری MVT فریم‌ورک Django از Modelها برای ارتباط با دیتابیس و ذخیره‌ی داده‌ها استفاده می‌شود بنابراین در ادامه به ساخت Modelهای برنامه می‌پردازیم. فایل models.py را در پوشه‌ی events باز کنید و کدهای زیر را در آن قرار دهید:

    from django.db import models
    from datetime import datetime
    from django.utils.timezone import now
    
    
    class Event(models.Model):
        class StateChoice(models.TextChoices):
            Iran = 'Iran, IR'
            Texas = 'Texas, TX'
            Alabama = 'Alabama, AL'
    
        title = models.CharField(max_length=50)
        place = models.CharField(max_length=50)
        city = models.CharField(max_length=10)
        state = models.CharField(
            max_length=50, choices=StateChoice.choices, default=StateChoice.Alabama)
        zipcode = models.CharField(max_length=10)
        other = models.CharField(max_length=50)
        start_date = models.CharField(max_length=25)
        end_date = models.CharField(max_length=25)
        category = models.CharField(max_length=25)
        list_date = models.DateTimeField(default=now, blank=True)
    
        class Meta:
            verbose_name_plural = 'events'
    
        def __str__(self):
            return self.title

    Register کردن Model در پنل مدیریت Django

    پس از ایجاد Model برنامه بایستی آن را در پنل مدیریت فریم‌ورک Django، ثبت یا به‌عبارتی register کنیم تا قابل استفاده باشد. به‌همین منظور فایل admin.py را که در پوشه‌ی events قرار دارد، باز کرده و کدهای زیر را در آن قرار دهید:

    from django.contrib import admin
    from .models import Event
    
    admin.site.register(Event)

    اضافه کردن فیلدهای مورد نیاز به دیتابیس

    در این آموزش تغییری در پیکربندی دیتابیس پروژه انجام نداده‌ایم و دیتابیس SQLite مناسب بود. حال برای اضافه کردن فیلدهای مورد نیاز به دیتابیس، دستورهای زیر را در مسیر پروژه اجرا کنید:

    python manage.py makemigrations
    python manage.py migrate

    و در ادامه با اجرای دستور زیر یک superuser بسازید و با آن در مرحله‌ی بعد وارد پنل مدیریتی Django شوید:

    python manage.py createsuperuser

    ایجاد چند رویداد نمونه در پنل مدیریت Django

    در ابتدا با دستور زیر در مسیر پروژه، برنامه‌ را راه‌اندازی کنید:

    python manage.py runserver

    سپس به آدرس localhost:8000/admin بروید و چند رویداد جدید ایجاد کنید:

    ایجاد چند رویداد جدید در صفحه‌ی مدیریت فریم‌ورک django

    تعریف و استفاده از Serializer در View برنامه

    پس از وارد کردن رویدادهای جدید، نوبت به تعریف Serializer برای Eventها می‌رسد تا بتوانیم داده‌ها را به XML یا JSON تبدیل کنیم. برای این کار یک فایل با نام serializers.py در مسیر برنامه‌ی خود ایجاد کرده و کدهای زیر را در آن قرار دهید:

    from rest_framework import serializers
    from .models import Event
    
    class EventSerializer(serializers.ModelSerializer):
        class Meta:
            model = Event
            fields = '__all__'

    با استفاده از ModelSerializer می‌توانیم به‌راحتی داده‌ها را به نوع‌های مختلفی تبدیل کنیم و در کدهای بالا تمام Fieldهای Model را Serialize کرده‌ایم.

    بیایید در ادامه‌ی همین بخش، Viewهای مورد نیاز برای عملیات CRUD را در فایل view.py که در پوشه‌ی events قرار دارد، وارد کنیم:

    from rest_framework.response import Response
    from .models import Event
    from .serializers import EventSerializer
    from rest_framework.decorators import api_view
    
    
    @api_view(['GET'])
    def eventList(request):
        events = Event.objects.all()
        serializer = EventSerializer(events, many=True)
        return Response(serializer.data)
    
    @api_view(['GET'])
    def eventDetail(request, pk):
        events = Event.objects.all(id=pk)
        serializer = EventSerializer(events, many=True)
        return Response(serializer.data)
    
    @api_view(['POST'])
    def eventCreate(request):
        serializer = EventSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
        return Response(serializer.data)
    
    @api_view(['POST'])
    def eventUpdate(request, pk):
        event = Event.objects.all(id=pk)
        serializer = EventSerializer(instance=event, data=request.data)
        
        if serializer.is_valid():
            serializer.save()
        return Response(serializer.data)
    
    @api_view(['DELETE'])
    def eventDelete(request, pk):
        event = Event.objects.all(id=pk)
        event.delete()
        return Response('Deleted')

    با import کردن rest_framework می‌توانیم محتوا را همان‌طور که درخواست شده، render کنیم و با دکوراتورهای api_view قادر خواهیم بود Viewهای مبتنی بر فانکشن بسازیم. این دکوراتورها به Django امکان می‌دهند تا نوع درخواستی که می‌خواهیم بر روی آن مدیریت داشته باشیم را متوجه شود.

    ما عملیات CRUD را با استفاده از queryهای مختلف به دیتابیس پیاده‌سازی کردیم و همان‌طور که قبل‌تر اشاره کرده بودیم از Serializerها در فریم‌ورک Django REST برای مدیریت انتقال داده‌ها استفاده می‌شود. بنابراین زمان آن فرا رسیده که URLهای مورد نیاز را برای Viewهای این پروژه ایجاد کنیم.

    تعریف و اضافه کردن URLهای برنامه به URLهای پروژه

    یک فایل با نام urls.py در پوشه‌ی برنامه‌ی خود ایجاد کنید و کدهای زیر را در آن قرار دهید:

    from django.urls import path
    from .import views
    urlpatterns = [
        path('',views.eventList,name="events"),
        path('detail/<str:pk>/',views.eventDetail,name="detail"),
        path('create',views.eventCreate,name="create"),
        path('update/<str:pk>/',views.eventUpdate,name="update"),
        path('delete/<str:pk>/',views.eventDelete,name="delete")
    ]

    در کدهای بالا برای تمام Viewها یک path تعریف کرده‌ایم. در مرحله‌ی بعد فایل urls.py اصلی را در پوشه‌ی پروژه Django باز کنید و URLهای برنامه را به‌صورت زیر در آن include کنید:

    from django.contrib import admin
    from django.urls import path, include
    from django.conf import settings
    from django.conf.urls.static import static
    
    urlpatterns = [
        path('admin/', admin.site.urls),
        path('api/events/', include('events.urls')),
    
    ]

    مشاهده‌ی خروجی نهایی پروژه

    می‌توان گفت که پروژه تکمیل شده است و می‌توانید با اجرای دوباره دستور زیر، خروجی نهایی پروژه را در آدرس localhost:8000/api/events مشاهده کنید:

    python manage.py runserver
    لیست رویدادهای موجود

    یا برای تفکیک رویدادها می‌توانید اولین رویداد را در آدرس localhost:8000/api/events/detail/1 مشاهده کنید:

    مشاهده‌ی جزئیات یک رویداد مشخص

    همچنین برای ایجاد رویدادهای جدید نیز می‌توانید وارد آدرس localhost:8000/api/events/create شوید و پس از وارد کردن داده‌های مورد نیاز برای ساخت رویداد بر روی دکمه‌ی POST کلیک کنید:

    ایجاد یک رویداد جدید

    ممکن است پس از ارسال داده‌های جدید به‌صورت خودکار id رویداد تغییر پیدا کند. در این مثال، id داده‌های ما از ۲ به ۶ تبدیل شده است زیرا چندین رویداد دیگر را برای آزمایش ایجاد و حذف کرده بودیم:

    یک رویداد ایجاد شده

    برای به‌روزرسانی رویدادی با آیدی ۲ می‌توانید وارد آدرس localhost:8000/api/events/update/2 شوید و با تغییر آیدی در پایان آدرس نیز می‌توانید داده‌های دیگری را به‌روزرسانی کنید:

    به‌روزرسانی یک رویداد مشخص

    و نتیجه به‌روزرسانی به صورت زیر خواهد بود:

    یک رویداد به‌روزرسانی شده

    در نهایت شاید بخواهید رویدادی را با آیدی ۲ را حذف کنید بنابراین آدرس localhost:8000/api/events/delete/2 را در مرورگر خود باز کرده و بر روی دکمه‌ی DELETE کلیک کنید:

    حذف یک رویداد مشخص

    پس از حذف رویداد یک پیغام با محتوای "Deleted" دریافت خواهید کرد:

    یک رویداد حذف شده

    منبع: https://dev.to/balt1794/django-rest-api-crud-tutorial-2894

    برچسب‌ها:

    خدمات رایگان لیارا

    ۲.۵ گیگابایت فضای ذخیره‌سازی ابری رایگان

    ۲.۵ گیگابایت Object Storage سازگار با پروتکل S3 با دیسک‌های SSD به‌صورت رایگان دریافت کنید.

    هاست رایگان برای دیتابیس‌

    دیتابیس‌های MariaDB، PostgreSQL و Redis را فقط با یک کلیک و به‌صورت رایگان تهیه کنید.

    سرویس DNS رایگان

    به سادگی دامنه‌تان را اضافه کنید و به صورت رایگان رکورد‌های آن را مدیریت کنید.

    ۱۰۰ هزار تومان اعتبار اولیه

    بعد از ثبت نام در لیارا مبلغ ۱۰۰ هزار تومان اعتبار هدیه دریافت می‌کنید که با توجه به ساعتی بودن هزینه سرویس‌ها، می‌توانید تمامی خدمات پولی را برای چندین هفته رایگان استفاده کنید.

    ارسال ۱۰۰ ایمیل تراکنشی رایگان در هر ماه

    در سرویس ایمیل لیارا شما می‌توانید تا ۱۰۰ ایمیل رایگان در هر ماه ارسال کنید و فقط برای بیش از آن هزینه پرداخت کنید. (به‌همراه دسترسی SMTP)

    هاست رایگان برای انواع وبسایت

    تفاوتی ندارد برای وبسایت خود از Node استفاده می‌کنید یا Laravel و Django، در لیارا می‌توانید به صورت کاملا رایگان آن را میزبانی کنید.

    توسعه‌دهندگان درباره‌ی ما چه می‌گویند

    تجربه کار باliara_cloud@امروز خیلی خوب بود. یکی از سرویس هام رو منتقل کردم روش و راضیم. انقد سریع و جذاب کارم راه افتادم اصن باورم نمیشد! برعکس سرویس های PaaS دیگه با اون همه پیچیدگیشون. دمتون گرم
    ...

    MohammadReza
    liara testimonial
    keikaavousi

    بعد از بسته شدن @fandoghpaas و ناراحتی همه‌مون از اینکه یه سرویس خوب و صادق نمی‌تونه از پس هزینه‌ها بر بیاد، سرویسم رو منتقل کردم به پاس لیارا (https://liara.ir @liara_cloud) . تجربه راحت و خوب. تفاوت‌هایی داشت که کمی کار می‌خواست ولی تا الان کاملا راضی.

    jadi
    liara testimonial
    jadi

    یه خسته نباشید باید به تصمیمliara_cloud@بگم،
    بعد از چندین روز سرکله زدن با سرویس های مشابه بالاخره تصمیم گرفتم لیارا رو امتحان کنم و باور نمیشه ۱۰ دقیقه بیشتر وقت نبرد،
    دمتون گرم.

    Arch
    liara testimonial
    EbadiDev

    واسه سرویس PaaS با اختلاف لیارا بهترین رابط کاربری داره و یکی از مزیت‌های سرویس دیتابیس‌شون اینه که خودشون به صورت دوره‌ای بکآپ میگیرن.
    ...

    Ali Najafi
    liara testimonial
    me_ali_najafi

    یکی از کارهای خوبی که جدیداً میکنم اینه که یه دیتابیس روی لیارا میسازم و به پروژه وصل میکنم اینطوری هم خونه و هم محل کار دیتابیس بروز رو دارم و راحت میتونم ادامه بدم کار روliara_cloud@

    Navid
    liara testimonial
    1navid

    عاشقliara_cloud@شدم درسته در حد AWS نیست ولی خب تجربه خوبی واسه پروژه های داخل ایران ارائه میده، میتونم رو CD هم اجراش کنم

    Amir H Shekari
    liara testimonial
    vanenshi

    همراه شما هستیم

    در خصوص سفارش یا استفاده از سرویس‌ها سوالی دارید؟
    تلفن واحد فروش:
    ۰۲۵-۳۳۵۵۷۶۱۹ (روزهای کاری ۹ الی ۱۷)
    تلفن واحد فروش: ۳۳۵۵۷۶۱۹-۰۲۵ (روزهای کاری ۹ الی ۱۷)