django-rest-framework開發api介面

(1) 創建django項目drfdemo1並且創建一個名為app的應用

django-admin startproject drfdemo1

python manage.py startapp app

(2) 安裝django-rest-framework

pip install djangorestframework

(3) 在settings.py的INSTALLED_APPS註冊，並且在INSTALLED_APPS和MIDDLEWARE配置屬性中將部分django自帶功能去除

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

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    # 'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

上述配置保留了Auth認證系統和Session功能，當django運行時只會載入Auth認證系統和Session功能,這樣能減少django占用伺服器的系統資源，除此之外還要註釋掉配置屬性TEMPLATES和STATIC_URL，因為API介面無需使用模板功能和靜態資源

(4) 路由配置

在drfdemo1的urls.py中編寫以下內容：

from django.urls import path, include

urlpatterns = [
    path('api/',include('app.urls')),
]

在app里創建urls.py，並寫入如下內容：

from django.urls import path
from .views import *

urlpatterns = [
    path('students/',students.as_view())
]

(5) 模型

from django.db import models


class studentsInfo(models.Model):
    name = models.CharField(max_length=12, verbose_name='姓名')
    sex = models.CharField(max_length=1, verbose_name='性別')
    age = models.IntegerField(verbose_name='年齡')
    classroom = models.CharField(max_length=10, verbose_name='教室')
    info = models.CharField(max_length=100, verbose_name='個人簡介')

(6) 在app里創建serializer.py，內容如下：

from rest_framework import serializers
from .models import *


class studentSerializer(serializers.ModelSerializer):

    class Meta:
        model = studentsInfo
        fields = "__all__"

(7) 視圖類編寫

from .models import *
from django.http import JsonResponse
from .serializer import studentSerializer
from rest_framework.views import APIView


class students(APIView):
    def get(self, request):
        data = studentsInfo.objects.all()
        serializer = studentSerializer(instance=data,many=True)
        return JsonResponse(serializer.data,safe=False)

(8) 執行數據遷移

python manage.py makemigrations
python manage.py migrate

遷移之後插入測試數據

(9) 啟動項目

python manage.py runserver 8000

(10) 查看返回的數據

訪問127.0.0.1/api/students，結果如下：

[
    {
        "id": 1,
        "name": "小明",
        "sex": "男",
        "age": 22,
        "classroom": "301",
        "info": "這個人很懶，什麼也沒有留下"
    },
    {
        "id": 2,
        "name": "小紅",
        "sex": "女",
        "age": 18,
        "classroom": "301",
        "info": "這個人很懶，什麼也沒有留下"
    },
    {
        "id": 3,
        "name": "張三",
        "sex": "男",
        "age": 25,
        "classroom": "307",
        "info": "這個人很懶，什麼也沒有留下"
    },
    {
        "id": 4,
        "name": "李四",
        "sex": "男",
        "age": 24,
        "classroom": "308",
        "info": "這個人很懶，什麼也沒有留下"
    }
]