Django rest_framework 编写 API

要使用 ** rest_framework ** 首先要安装相关的库:

pip install djangorestframework

在这个例子中,我们创建一个书目的 API,首先创建一个 Django 项目,项目中创建一个名为: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 里面没找到 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

记得执行 makemigrations 和 migrate 两个命名。

然后编辑 admin.py 如下:

from django.contrib import admin
from library.models import Book  

admin.site.register(Book)  

创建超级用户后,在后台添加相关的书目信息:

3.创建 API



我们在 library 文件夹内新建一个文件 api,py,编辑该文件:

from library.models import Book

# 序列化器,把数据包装成类似字典的格式
from rest_framework import serializers

# 这两个模块把序列化后的数据包装成 api
from rest_framework.response import Response
from rest_framework.decorators import api_view

# 创建一个 Book 的序列化器
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book  # 序列化的对象
        fields = '__all__'  # 序列化的属性
        # fields = ('title', 'author')  # 如果只需要序列化某几个属性可以用元组


@api_view(['GET'])  # 装饰器,使得 book 函数具有 api_view 的相关方法 
def book(request):
    book_list = Book.objects.all() # Book 的全部数据
    serializer = BookSerializer(book_list, many=True) # 序列化 Book 的数据
    return Response(serializer.data)

4.设置 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),
]

打开:http://127.0.0.1:8000/api/book ,可以看到 API 创建完成:

如果要返回 json,可以用:http://127.0.0.1:8000/api/book?format=json

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,012评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,628评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,653评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,485评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,574评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,590评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,596评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,340评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,794评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,102评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,276评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,940评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,583评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,201评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,441评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,173评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,136评论 2 352

推荐阅读更多精彩内容