要使用 ** rest_framework ** 首先要安裝相關(guān)的庫(kù)：
pip install djangorestframework
在這個(gè)例子中狸窘，我們創(chuàng)建一個(gè)書(shū)目的 API，首先創(chuàng)建一個(gè) Django 項(xiàng)目沪悲，項(xiàng)目中創(chuàng)建一個(gè)名為：library 的 app蹲姐，文件目錄如下：
1.編輯 setting
編輯 setting.py 的 INSTALLED_APPS 部分，添加 library 和 rest_framework：
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'library',
'rest_framework', # 要使用rest_framework需要在這里添加上
]
如果你的 setting.py 里面沒(méi)找到 REST_FRAMEWORK元潘，加上以下部分：
REST_FRAMEWORK = {
'DEFAULT_AUTHENTICATION_CLASSES': (
# 'rest_framework.authentication.SessionAuthentication',
# 'rest_framework_jwt.authentication.JSONWebTokenAuthentication',
),
'DEFAULT_PERMISSION_CLASSES': (
# 'rest_framework.permissions.IsAuthenticated',
),
}
2.編輯 model 和 admin
編輯 model.py 如下：
from django.db import models
# Create your models here.
class Book(models.Model):
title = models.CharField(null=True, blank=True, max_length=50)
author = models.CharField(null=True, blank=True, max_length=50)
summary = models.TextField(null=True, blank=True)
def __str__(self):
return self.title
記得執(zhí)行 makemigrations 和 migrate 兩個(gè)命名畔乙。
然后編輯 admin.py 如下：
from django.contrib import admin
from library.models import Book
admin.site.register(Book)
創(chuàng)建超級(jí)用戶后，在后臺(tái)添加相關(guān)的書(shū)目信息：
3.創(chuàng)建 API
我們?cè)?library 文件夾內(nèi)新建一個(gè)文件 api,py翩概，編輯該文件：
from library.models import Book
# 序列化器牲距，把數(shù)據(jù)包裝成類似字典的格式
from rest_framework import serializers
# 這兩個(gè)模塊把序列化后的數(shù)據(jù)包裝成 api
from rest_framework.response import Response
from rest_framework.decorators import api_view
# 創(chuàng)建一個(gè) Book 的序列化器
class BookSerializer(serializers.ModelSerializer):
class Meta:
model = Book # 序列化的對(duì)象
fields = '__all__' # 序列化的屬性
# fields = ('title', 'author') # 如果只需要序列化某幾個(gè)屬性可以用元組
@api_view(['GET']) # 裝飾器，使得 book 函數(shù)具有 api_view 的相關(guān)方法
def book(request):
book_list = Book.objects.all() # Book 的全部數(shù)據(jù)
serializer = BookSerializer(book_list, many=True) # 序列化 Book 的數(shù)據(jù)
return Response(serializer.data)
4.設(shè)置 URL
編輯 url.py:
from django.conf.urls import url
from django.contrib import admin
from library.api import book
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^api/book', book),
]
打開(kāi)：http://127.0.0.1:8000/api/book 钥庇，可以看到 API 創(chuàng)建完成：
如果要返回 json牍鞠，可以用：http://127.0.0.1:8000/api/book?format=json
