คู่มือสร้าง REST API ด้วย Django REST Framework

สร้าง RESTful API ด้วย Django REST Framework: คู่มือฉบับนักพัฒนาไทย

Estimated reading time: 15 minutes

  • Django REST Framework (DRF) ช่วยให้การสร้าง API เป็นเรื่องง่ายและรวดเร็ว
  • DRF มีเครื่องมือ serialization, authentication, และ versioning ที่จำเป็น
  • การติดตั้ง DRF ทำได้ง่ายผ่าน pip และการตั้งค่าใน settings.py
  • ViewSet ช่วยจัดการ API endpoints ต่าง ๆ ได้อย่างมีประสิทธิภาพ
  • การปรับแต่ง API สามารถทำได้ผ่าน permissions, pagination, และ filtering

Table of Contents:

Django REST Framework คืออะไร และทำไมถึงควรใช้?

ในโลกปัจจุบันที่แอปพลิเคชันและระบบต่าง ๆ สื่อสารกันผ่านอินเทอร์เน็ตมากขึ้น การสร้าง API (Application Programming Interface) ที่มีประสิทธิภาพและใช้งานง่ายจึงมีความสำคัญอย่างยิ่ง การสร้าง RESTful API ด้วย Django REST Framework เป็นทางเลือกที่ได้รับความนิยมอย่างมากในหมู่นักพัฒนา Python โดยเฉพาะอย่างยิ่งในประเทศไทย เนื่องจาก Django REST Framework (DRF) ช่วยให้การสร้าง API เป็นเรื่องง่าย รวดเร็ว และมีประสิทธิภาพ

บทความนี้จะนำเสนอคู่มือฉบับนักพัฒนาไทยในการสร้าง RESTful API ด้วย Django REST Framework โดยจะครอบคลุมตั้งแต่พื้นฐานของการติดตั้งและตั้งค่า ไปจนถึงการสร้าง API endpoints ที่ซับซ้อน พร้อมทั้งเคล็ดลับและแนวทางปฏิบัติที่ดีที่สุดเพื่อให้คุณสามารถสร้าง API ที่แข็งแกร่งและพร้อมใช้งานจริง

Django REST Framework คือชุดเครื่องมือ (toolkit) ที่มีประสิทธิภาพและยืดหยุ่นสำหรับการสร้าง Web APIs ใน Django ซึ่งเป็น Python web framework ยอดนิยม DRF ช่วยลดความซับซ้อนในการพัฒนา API โดยการมอบเครื่องมือสำเร็จรูปที่จำเป็น เช่น:

* **Serialization:** แปลงข้อมูลจาก Python objects ให้เป็น JSON หรือรูปแบบอื่น ๆ ที่สามารถส่งผ่านเครือข่ายได้ และแปลงข้อมูลจาก JSON กลับเป็น Python objects* **Authentication & Authorization:** รองรับวิธีการตรวจสอบสิทธิ์และการให้สิทธิ์ที่หลากหลาย เช่น Token authentication, OAuth, และ JSON Web Tokens (JWT)* **Versioning:** ช่วยจัดการการเปลี่ยนแปลง API ในแต่ละเวอร์ชันได้อย่างมีประสิทธิภาพ* **Browsable API:** สร้างหน้า API ที่สามารถเรียกดูและทดสอบ endpoints ได้ง่าย

เหตุผลที่ควรใช้ Django REST Framework:

* ลดเวลาในการพัฒนา: DRF มีเครื่องมือและ components ที่พร้อมใช้งาน ช่วยให้คุณสร้าง API ได้เร็วกว่าการเขียน code เองทั้งหมด* เพิ่มความสามารถในการบำรุงรักษา: Code ที่เขียนด้วย DRF มีโครงสร้างที่เป็นระเบียบและง่ายต่อการอ่าน ทำให้การบำรุงรักษาและการปรับปรุงเป็นเรื่องง่าย* รองรับมาตรฐาน REST: DRF ถูกออกแบบมาให้สอดคล้องกับหลักการของ REST (Representational State Transfer) ทำให้ API ที่สร้างขึ้นมีความสอดคล้องและใช้งานง่าย* ชุมชนขนาดใหญ่: DRF มีชุมชนนักพัฒนาที่แข็งแกร่งและให้การสนับสนุน ทำให้คุณสามารถหาความช่วยเหลือและเรียนรู้จากผู้อื่นได้ง่าย

การติดตั้งและตั้งค่า Django REST Framework

ก่อนที่จะเริ่มสร้าง API เราต้องติดตั้งและตั้งค่า Django REST Framework ในโปรเจกต์ Django ของเราก่อน

ขั้นตอนที่ 1: ติดตั้ง Django REST Framework

เปิด terminal หรือ command prompt แล้วใช้ pip เพื่อติดตั้ง DRF:

bashpip install djangorestframework

ขั้นตอนที่ 2: เพิ่ม Django REST Framework ใน INSTALLED_APPS

แก้ไขไฟล์ `settings.py` ในโปรเจกต์ Django ของคุณ และเพิ่ม `'rest_framework'` ลงใน `INSTALLED_APPS`:

pythonINSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', 'rest_framework', # เพิ่มบรรทัดนี้ # ... แอปพลิเคชันอื่น ๆ ของคุณ]

ขั้นตอนที่ 3: (Optional) ตั้งค่า Authentication Default

คุณสามารถตั้งค่า authentication default ในไฟล์ `settings.py` เพื่อกำหนดวิธีการตรวจสอบสิทธิ์ที่ใช้ใน API ของคุณ ตัวอย่างเช่น:

pythonREST_FRAMEWORK = { 'DEFAULT_AUTHENTICATION_CLASSES': [ 'rest_framework.authentication.TokenAuthentication', 'rest_framework.authentication.SessionAuthentication', ], 'DEFAULT_PERMISSION_CLASSES': [ 'rest_framework.permissions.IsAuthenticated', ]}

ในตัวอย่างนี้ เราได้ตั้งค่าให้ใช้ `TokenAuthentication` และ `SessionAuthentication` เป็นวิธีการตรวจสอบสิทธิ์ และกำหนดให้ผู้ใช้ต้อง authenticated ก่อนที่จะสามารถเข้าถึง API ได้

การสร้าง API Endpoints

เมื่อติดตั้งและตั้งค่า DRF เรียบร้อยแล้ว เราก็พร้อมที่จะเริ่มสร้าง API endpoints

ตัวอย่าง: สร้าง API สำหรับจัดการข้อมูลสินค้า

สมมติว่าเราต้องการสร้าง API สำหรับจัดการข้อมูลสินค้า (Product) ซึ่งมี fields เช่น `name`, `description`, และ `price`

ขั้นตอนที่ 1: สร้าง Model

สร้างไฟล์ `models.py` ในแอปพลิเคชัน Django ของคุณ และกำหนด Product model:

pythonfrom django.db import modelsclass Product(models.Model): name = models.CharField(max_length=255) description = models.TextField() price = models.DecimalField(max_digits=10, decimal_places=2) def __str__(self): return self.name

ขั้นตอนที่ 2: สร้าง Serializer

Serializer ทำหน้าที่แปลงข้อมูลจาก Product model ให้เป็น JSON และแปลง JSON กลับเป็น Product model สร้างไฟล์ `serializers.py` ในแอปพลิเคชันของคุณ:

pythonfrom rest_framework import serializersfrom .models import Productclass ProductSerializer(serializers.ModelSerializer): class Meta: model = Product fields = '__all__' # หรือระบุ fields ที่ต้องการ

ใน `ProductSerializer` เราใช้ `ModelSerializer` ซึ่งเป็น shortcut ที่ช่วยสร้าง serializer จาก model ได้อย่างรวดเร็ว `fields = '__all__'` หมายถึงให้ใช้ทุก fields ใน Product model

ขั้นตอนที่ 3: สร้าง ViewSet

ViewSet เป็น class ที่รวบรวม logic สำหรับการจัดการ API endpoints ต่าง ๆ เช่น list, create, retrieve, update, และ delete สร้างไฟล์ `views.py` ในแอปพลิเคชันของคุณ:

pythonfrom rest_framework import viewsetsfrom .models import Productfrom .serializers import ProductSerializerclass ProductViewSet(viewsets.ModelViewSet): queryset = Product.objects.all() serializer_class = ProductSerializer

`ModelViewSet` เป็น shortcut ที่มี methods สำหรับ CRUD (Create, Read, Update, Delete) operations เตรียมไว้ให้แล้ว

ขั้นตอนที่ 4: กำหนด URL Routing

กำหนด URL routing สำหรับ ProductViewSet ในไฟล์ `urls.py` ของโปรเจกต์ Django:

pythonfrom django.urls import path, includefrom rest_framework import routersfrom . import viewsrouter = routers.DefaultRouter()router.register(r'products', views.ProductViewSet)urlpatterns = [ path('', include(router.urls)),]

`DefaultRouter` จะสร้าง URL patterns ที่จำเป็นสำหรับการเข้าถึง ProductViewSet

ขั้นตอนที่ 5: ทดสอบ API

รัน Django development server:

bashpython manage.py runserver

เปิด browser และไปที่ `http://127.0.0.1:8000/products/` คุณจะเห็น browsable API ที่ DRF สร้างขึ้น ซึ่งช่วยให้คุณสามารถเรียกดูและทดสอบ API endpoints ได้

การปรับแต่ง API Endpoints

นอกจากการสร้าง API endpoints พื้นฐานแล้ว เรายังสามารถปรับแต่ง DRF เพื่อให้ API ของเรามีความยืดหยุ่นและตอบสนองความต้องการที่ซับซ้อนมากขึ้น

การใช้ Permissions

DRF มี permission classes ที่ช่วยควบคุมการเข้าถึง API endpoints ตัวอย่างเช่น:

* `IsAuthenticated`: กำหนดให้ผู้ใช้ต้อง authenticated ก่อนที่จะสามารถเข้าถึง API ได้* `IsAdminUser`: กำหนดให้เฉพาะ admin users เท่านั้นที่สามารถเข้าถึง API ได้* `AllowAny`: อนุญาตให้ทุกคนเข้าถึง API ได้

คุณสามารถกำหนด permission classes ใน ViewSet ของคุณ:

pythonfrom rest_framework import viewsets, permissionsfrom .models import Productfrom .serializers import ProductSerializerclass ProductViewSet(viewsets.ModelViewSet): queryset = Product.objects.all() serializer_class = ProductSerializer permission_classes = [permissions.IsAuthenticatedOrReadOnly] # อนุญาตให้ authenticated users สามารถเขียนได้

การใช้ Pagination

Pagination ช่วยแบ่งข้อมูลที่ API ส่งกลับมาเป็นหน้า ๆ เพื่อให้ง่ายต่อการจัดการกับข้อมูลจำนวนมาก DRF มี pagination classes ที่ช่วยให้คุณสามารถใช้งาน pagination ได้อย่างง่ายดาย:

pythonREST_FRAMEWORK = { 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', 'PAGE_SIZE': 10 # กำหนดขนาดของแต่ละหน้า}

การใช้ Filtering

Filtering ช่วยให้ผู้ใช้สามารถกรองข้อมูลที่ API ส่งกลับมาได้ DRF มี filtering backends ที่ช่วยให้คุณสามารถใช้งาน filtering ได้อย่างง่ายดาย:

pythonfrom rest_framework import viewsets, filtersfrom .models import Productfrom .serializers import ProductSerializerclass ProductViewSet(viewsets.ModelViewSet): queryset = Product.objects.all() serializer_class = ProductSerializer filter_backends = [filters.SearchFilter, filters.OrderingFilter] search_fields = ['name', 'description'] ordering_fields = ['name', 'price']

ในตัวอย่างนี้ เราได้เพิ่ม `SearchFilter` และ `OrderingFilter` ซึ่งช่วยให้ผู้ใช้สามารถค้นหาและเรียงลำดับข้อมูลได้

แนวทางปฏิบัติที่ดีที่สุดสำหรับการสร้าง RESTful API

* ใช้ HTTP Methods อย่างถูกต้อง: ใช้ GET สำหรับการดึงข้อมูล, POST สำหรับการสร้างข้อมูลใหม่, PUT สำหรับการอัปเดตข้อมูลทั้งหมด, PATCH สำหรับการอัปเดตข้อมูลบางส่วน, และ DELETE สำหรับการลบข้อมูล* ใช้ HTTP Status Codes อย่างถูกต้อง: ใช้ 200 OK สำหรับการ request ที่สำเร็จ, 201 Created สำหรับการสร้างข้อมูลใหม่สำเร็จ, 400 Bad Request สำหรับ request ที่ไม่ถูกต้อง, 401 Unauthorized สำหรับ request ที่ไม่ได้รับอนุญาต, 404 Not Found สำหรับ resource ที่ไม่พบ, และ 500 Internal Server Error สำหรับข้อผิดพลาดภายใน server* ออกแบบ URLs ให้สื่อความหมาย: ใช้ URLs ที่สื่อความหมายและง่ายต่อการเข้าใจ เช่น `/products`, `/products/{id}`, `/categories`, `/categories/{id}`* ใช้ Pagination สำหรับข้อมูลจำนวนมาก: แบ่งข้อมูลที่ API ส่งกลับมาเป็นหน้า ๆ เพื่อให้ง่ายต่อการจัดการ* ใช้ Filtering เพื่อให้ผู้ใช้สามารถกรองข้อมูลได้: อนุญาตให้ผู้ใช้สามารถกรองข้อมูลที่ต้องการได้* มี Documentation ที่ดี: สร้าง documentation ที่ชัดเจนและครบถ้วนเพื่อให้ผู้ใช้สามารถเข้าใจและใช้งาน API ของคุณได้อย่างถูกต้อง

ประโยชน์ของการใช้ Django REST Framework สำหรับธุรกิจในประเทศไทย

สำหรับธุรกิจในประเทศไทยที่กำลังมองหาโซลูชันในการพัฒนา API, Django REST Framework เป็นตัวเลือกที่น่าสนใจด้วยเหตุผลหลายประการ:

* ความง่ายในการเรียนรู้และใช้งาน: Python เป็นภาษาโปรแกรมที่ได้รับความนิยมและมี community ขนาดใหญ่ในประเทศไทย ทำให้การหาทีมงานที่มีความรู้ความสามารถในการใช้ Django และ DRF เป็นเรื่องง่าย* ความรวดเร็วในการพัฒนา: DRF ช่วยลดเวลาในการพัฒนา API ทำให้ธุรกิจสามารถเปิดตัวผลิตภัณฑ์และบริการใหม่ ๆ ได้อย่างรวดเร็ว* ความสามารถในการปรับแต่ง: DRF มีความยืดหยุ่นสูง ทำให้ธุรกิจสามารถปรับแต่ง API ให้ตรงกับความต้องการเฉพาะของตนเองได้* ความคุ้มค่า: DRF เป็น open-source framework ที่ไม่มีค่าใช้จ่ายในการใช้งาน ทำให้ธุรกิจสามารถประหยัดค่าใช้จ่ายในการพัฒนา API ได้

บริษัทของเราและความเชี่ยวชาญด้าน IT System Development & Software Development

ในฐานะบริษัทที่ปรึกษาด้าน IT ชั้นนำในประเทศไทย เรามีความเชี่ยวชาญในการให้คำปรึกษาและพัฒนา IT System Development & Software Development โซลูชันที่ตอบโจทย์ความต้องการของธุรกิจในทุกขนาด เรามีทีมงานที่มีประสบการณ์ในการใช้ Django REST Framework และเทคโนโลยีอื่น ๆ ที่เกี่ยวข้อง เพื่อช่วยให้ธุรกิจของคุณสามารถสร้าง API ที่มีประสิทธิภาพและตอบสนองความต้องการของลูกค้าได้อย่างเต็มที่

เราให้บริการ:

* การให้คำปรึกษาด้าน API Strategy: ช่วยให้คุณกำหนดกลยุทธ์ในการพัฒนา API ที่เหมาะสมกับธุรกิจของคุณ* การพัฒนา API ด้วย Django REST Framework: สร้าง API ที่มีประสิทธิภาพและปรับแต่งได้ตามความต้องการของคุณ* การทดสอบและดูแลรักษา API: มั่นใจได้ว่า API ของคุณทำงานได้อย่างราบรื่นและปลอดภัย

สรุปและ Call to Action

การสร้าง RESTful API ด้วย Django REST Framework เป็นทักษะที่สำคัญสำหรับนักพัฒนาในยุคปัจจุบัน DRF ช่วยลดความซับซ้อนในการพัฒนา API และทำให้การสร้าง API เป็นเรื่องง่าย รวดเร็ว และมีประสิทธิภาพ

หากคุณกำลังมองหาโซลูชันในการพัฒนา API หรือต้องการคำปรึกษาด้าน IT System Development & Software Development ติดต่อมีศิริ ดิจิทัลวันนี้เพื่อเรียนรู้เพิ่มเติมเกี่ยวกับบริการของเราและวิธีที่เราสามารถช่วยให้ธุรกิจของคุณประสบความสำเร็จ

ติดต่อเรา: มีศิริ ดิจิทัล

เรียนรู้เพิ่มเติมเกี่ยวกับบริการของเรา: [ใส่ลิงก์ไปยังหน้าบริการ IT System Development & Software Development ของมีศิริ ดิจิทัล]

เราหวังว่าบทความนี้จะเป็นประโยชน์สำหรับนักพัฒนาไทยที่ต้องการสร้าง RESTful API ด้วย Django REST Framework ขอให้สนุกกับการพัฒนา!

FAQ

สร้างแอปข้ามแพลตฟอร์ม Flutter Firebase ในไทย