Viết API sử dụng Django REST framework với PostgreSQL
Bài đăng này đã không được cập nhật trong 3 năm
Giới thiệu
Trong bối cảnh phát triển web, chúng ta thường nói về RESTful API. Đây là một cách phổ biển để cung cấp ứng dụng cho bên thứ ba ( các ứng dụng và web ). Điều này chỉ cần cung cấp thông tin lưu trữ trong cơ sở dữ liệu ở định dạng phổ biến như XML hoặc JSON, bằng cách này một ứng dụng bên thứ ba có thể tương tác với dữ liệu mà không cần kết nối trực tiếp với cơ sở dữ liệu , cũng vì thế không quan trọng cơ sở dữ liệu là MySQL hay PostgreSQL, hoặc nếu ứng dụng được viết bằng Java hoặc Python, nhưng RESTful APIs có thể được sử dụng để sửa chữa cơ sở dữ liệu.
Django REST framework là một công cụ hỗ trợ đắc lực trong việc xây dựng WebAPI. Một số lý do khi ta nên sử dụng REST:
- Có hỗ trợ dữ liệu ORM và non-ORM với Serialization.
- Tài liệu phong phú, cộng đồng hỗ trợ lớn.
- Được sử dụng trong các công ty quốc tế như Mozilla, Red Hat, Heroku.
Cài đặt
1.Django và Django REST framework
Ta sử dụng lần lượt các câu lệnh sau:
pip install django
django -admin --vesion // check phiên bản đã cài đặt
Sau đó ta tạo một folder chứa application:
mkdir TodosProject
cd TodosProject
django-admin startproject todos
Tiếp theo install Django REST framework:
pip install djangorestframework
Và phần cài đặt và kết nối Django với Postgres thì ta làm theo bài viết sau:
https://viblo.asia/p/ket-noi-django-va-postgresql-nhu-the-nao-4P856NDa5Y3.
Như vậy ta tạm thời có đủ các công cụ cần thiết. Bây giờ là Chiến 
!!!
Thực hiện
Trong folder Django ta vừa tạo bên trên có cấu trúc như sau:
Các thành phần cụ thể như sau:
- admin.py : File config trong trang admin của app.
- models.py: Nơi tạo dữ liệu, các trường, các bảng.
- test.py : File unit test.
- views.py : Truy vấn dữ liệu từ model. Trước hết là như thế đã.
1. Models
Để đơn giản ta tạo thử một models.py như sau:
Ta hiểu trong class model chính là tên bảng có các thuộc tính chính là các trường dữ liệu mà ta muốn tạo ở PostgresSQL.
Với file admin.py ta sẽ có các list thuộc tính ta đã khai báo trong file models.py :
File app.py:
Ta tạo một folder api gồm serializers.py và viewset.py.Đây là 2 file ta sẽ code thao tác để tạo được API.
Trong file serializers.py như sau:
from rest_framework import serializers
from todos.models import Company
class CompanySerialiser(serializers.HyperlinkedModelSerializer):
class Meta:
model = Company
fields = ('_id', 'name', 'age', 'adress', 'salary', 'join_date')
FIle viewset.py như sau :
from django.http import JsonResponse
from todos.models import Company
def getJson(request):
obj = Company.objects.all()
data = { "result" :list(obj.values("_id", "name", "age", "adress", "salary", "join_date"))
}
return JsonResponse(data)
Bên trên là kết quả mà ta nhận được hiển thị một chuỗi Json có dạng :
{ "result" : [
{ "id": value,
"name": value,
"age": value,
"adress" : value,
"salary" : value,
"join_date" :value
}
]}
Cụ thể kết quả ta xem bên dưới.
2.Settings
Phần quan trọng tiếp theo ta cài đặt DjangoRest framework trong file settings.py :
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'rest_framework',
'todos'
]
REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
# or allow read-only access for unauthenticated users.
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
]
}
3.Urls
Để lấy được data ta tạo chuỗi URLs trong file urls.py:
from django.contrib import admin
from django.urls import path, include
from rest_framework import routers
from todos.api.viewset import getJson
router = router. DefaultRouter()
urlpattenrns = [
path('admin/',admin.site.urls),
path(r'',include(router.urls),
path(r'api/data/', getJson, name='getJson')
]
Ta có thể tùy chỉnh URL trong hàm path bên trên.
4.Run
Vậy là ta đã hoàn thành phần code xây dựng API. Để run được ta dùng lệnh :
python manage.py makemigrations
python manage.py migrate
# Run
python manage.py runserver
Khi start ta thấy :
Ta sẽ chạy server bên trên ta được:
Ta thêm / admin vào đường link bên trên ta sẽ vào được trang quản trị.
Note : Điểu quan trọng các bạn đã tạo createsuperuser trước khi vào trang này. Cách tạo có trong link Viblo bên trên.
Khi vào ta sẽ thấy bảng Company và khi nhấn vào ta sẽ thấy các trường ta đã code trong models.py:
Hình 1. Link đầu tiên
Ta thử thêm các dữ liệu vào SAVE :
Vậy là ta đã có dữ liệu . Bây giờ là lấy data dạng Json. Nhớ lại lúc ta code file urls.py thì URL có thêm /api/data.Kết quả nhận được như sau:
Thử với Postman:
Ngon lành cành đào.Hehe !!
Ta cũng thử check xem db có được tạo hay chưa bằng terminal:
Đã OK...
Kết luận
Vậy là ta đã tạo một app đơn giản sử dụng Django Rest framework sử dụng PostgresSQL. Trong quá trình thực hiện ta sẽ gặp một số lỗi về connect PostgresSQL với Django, không insert được data, không lấy được data,...nếu thấy căng thẳng hãy đứng dậy đi lại, uống nước rồi sau đó fix lỗi tiếp dù không biết có thành công hay không 
Ngoài ra các bạn cũng truy cập vào link :
https://www.django-rest-framework.org/tutorial/quickstart/ để xem thêm nhiều thứ hay ho.
Chúc các bạn may mắn. Hẹn gặp lại vào bài viết tiếp theo.
Tài liệu tham khảo
All rights reserved
