使用Django开发REST接口

  我们以在Django框架中使用的图书以及书中人物案例来写一套支持图书数据增删改查REST API接口,来理解REST API的开发(前后端均发送JSON格式数据)

路由代码(urls.py):

urlpatterns = [
path('books/', views.BookListView.as_view()),
re_path('books/(?P<pk>\d+)/', views.BookDetailView.as_view())
]

views.py:

from datetime import datetime
from django.http import JsonResponse,HttpResponse
import json class BookListView(View):
"""
查询所有的书籍、增加书籍
"""
def get(self,request):
"""
查询所有的书籍,
路由:GET /books/
:param request:
:return:
"""
queryset = BookInfo.objects.all()
book_list = []
for book in queryset:
book_list.append({
"id":book.id,
"btitle":book.title,
"bpub_date":book.pub_date,
"bread":book.read,
"bcommet":book.comment,
"image":book.image.url if book.image else ""
})
#为了不使字典的数据发送,将参数safe变为False
return JsonResponse(book_list,safe=False) def post(self,request):
"""
新增书籍
路由:POST/books/
:param request:
:return:
"""
json_bytes = request.body
json_str = json_bytes.decode()
#将字符串对象反序列化
book_dict = json.loads(json_str)
################################
book = BookInfo.objects.create(
title = book_dict.get("btitle"),
pub_date = book_dict.get("bpub_date")
#.....................省略其他参数
)
#返回插入的数据,以json格式返回,并且带上状态码
return JsonResponse({
"id":book.id,
"btitle":book.title,
'bpub_date': book.pub_date,
'bread': book.read,
'bcomment': book.comment,
'image': book.image.url if book.image else ''
},status=201)
class BookDetailView(View):
def get(self,request,pk):
"""
获取单个图书信息
路由:GET/books/<pk>/
:param request:
:param pk:
:return:
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404) return JsonResponse({
"id": book.id,
"btitle": book.title,
'bpub_date': book.pub_date,
'bread': book.read,
'bcomment': book.comment,
'image': book.image.url if book.image else ''
})
def put(self,request,pk):
"""
修改图书信息
路由:PUT/books/<pk>/
:param request:
:param pk:
:return:
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404) json_bytes = request.body
json_str = json_bytes.decode()
book_dict = json.loads(json_str) ##########此处详细的校验参数省略############# book.title = book_dict.get('btitle')
book.pub_date = book_dict.get('bpub_date')
book.save() return JsonResponse({
"id": book.id,
"btitle": book.title,
'bpub_date': book.pub_date,
'bread': book.read,
'bcomment': book.comment,
'image': book.image.url if book.image else ''
}) def delete(self,request,pk):
"""
删除图书
路由:DELETE/books/<pk>/
:param request:
:param pk:
:return:
"""
try:
book = BookInfo.objects.get(pk=pk)
except BookInfo.DoesNotExist:
return HttpResponse(status=404)
book.delete()
return HttpResponse(status=204)

views.py

测试:

使用Postman软件测试接口

1、获取所有图书信息

GET方式访问http://127.0.0.1:8000/books/,返回状态码200以及json数据

2、获取单一的图书数据

GET 访问 http://127.0.0.1:8000/books/5/ ,返回状态码200以及json数据

3、新增书籍信息

POST访问http://127.0.0.1:8000/books/,发送json数据,返回json数据以及状态码

4、修改书籍数据

PUT访问http://127.0.0.1:8000/books/2/,发送json数据,返回json数据以及状态码

5、删除书籍数据

DELETE访问http://127.0.0.1:8000/books/2/,发送json数据,返回状态码204

2、明确REST接口开发的核心任务

在上面的案例中,在开发REST API接口时候,视图主要做的三件事:

  1、将请求的数据(如json格式)转化为模型类对象

  2、操作数据库(增删改查)

  3、将模型类对象转换为响应的数据(如json数据格式)

序列化(Serialization)

  就是将程序中的一个数据结构类型转化为其他格式(字典、json、XML等)。例如在Django中的模型类对象转换为JSON字符串,这就是序列化(json.dumps())

  反之,将其他数据字典、json、XML等)转化为程序的数据,例如将JSON字符串转换为Django中的模型类对象,这个过程就叫反序列化(json.load())

  在开发REST API时,视图中要频繁的进行序列化与反序列化。

总结:

  在开发REST API接口,在视图中需要做的核心就是:1、将数据库数据序列化(json.dumps())为前端所需要的格式,并返回。2、将前端发送的数据反序列化(json.load())为模型类对象,保存在数据库中。

Django REST  framework介绍:

  在序列化与反序列化时,虽然操作的数据不尽相同,但是执行的过程却是相似的,也就是说这部分代码是可以复用简化编写的。

  在开发REST API的视图中,虽然每个视图具体操作的数据不同,但增、删、改、查的实现流程基本套路化,所以这部分代码也是可以复用简化编写的:

  1. 增:校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
  2. 删:判断要删除的数据是否存在 -> 执行数据库删除
  3. 改:判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
  4. 查:查询数据库 -> 将数据序列化并返回

  Django REST framework可以帮助我们简化上述两部分的代码编写,大大提高REST API的开发速度。Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。通常简称为DRF框架 或 REST framework。DRF框架是建立在Django框架基础之上,由Tom Christie大牛二次开发的开源项目。

特点

  • 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
  • 提供了丰富的类视图、Mixin扩展类,简化视图的编写;
  • 丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
  • 多种身份认证和权限认证方式的支持;
  • 内置了限流系统;
  • 直观的 API web 界面;
  • 可扩展性,插件丰富

15-Django开发REST接口的更多相关文章

  1. python3.8.0 Django 开发后端接口api 部署到 Linux Centos7上

    经历了两天的时候终于把本地使用python3 django开发的接口API部署到服务器上了,还是记录一下,以免之后忘记,哈哈 注意一点,就是,centos7是基于python2的,我这边默认的是pyt ...

  2. django开发后台接口error 10053/10054

    初学Django,开发完接口之后访问post请求的接口遇到error10053和10054,查阅很多资料没有找到具体的原因. 在这里记录下我遇到这两个报错的原因和解决方案: get请求取请求参数:su ...

  3. 使用Django开发简单接口:文章增删改查

    目录 1.一些准备工作 安装django 创建django项目 创建博客应用(app) 2.models.py 3.django admin 登录 创建超级用户 4.修改urls.py 5.新增文章接 ...

  4. django开发最完美手机购物商城APP带前后端源码

    后端和数据接口,全采用django开发 从0到大神的进阶之路 一句话,放弃单文件引用vue.js练手的学习方式 马上从vue-cli4练手,要不然,学几年,你也不懂组件式开发,不懂VUEX,不懂路由, ...

  5. 04.开发REST 接口

    使用Django开发REST 接口 我们以在Django框架中使用的图书英雄案例来写一套支持图书数据增删改查的REST API接口,来理解REST API的开发. 在此案例中,前后端均发送JSON格式 ...

  6. 15款Django开发常用软件包(转)

    原文:http://www.iteye.com/news/28697 Django是一款高级的Python Web框架,可以帮助开发者快速创建web应用.我们这里整理了15款Django开发中常用的软 ...

  7. Django:前后端分离 djangorestframework开发API接口 serializer序列化认证组件

    参考:https://blog.csdn.net/zhangmengran/article/details/84887206 目的: 使用serializer序列化器将QuerySet数据序列化为js ...

  8. Django开发常用方法及面试题

    目录 1.对Django的认识? 2.Django .Flask.Tornado的对比 3.什么是wsgi,uwsgi,uWSGI? 4. django请求的生命周期? 5. 简述什么是FBV和CBV ...

  9. Django开发笔记之数据库的设计

    后台采用Django开发,可以体会到开发的便利之处,对于一个项目来说,首先最重要的是数据库的设计,那么在Django下数据库设计主要是如下步骤: 1,需求分析,这点子不用多说,而我也深刻体会到了没有原 ...

随机推荐

  1. OpenGL 之 Compute Shader(通用计算并行加速)

    平常我们使用的Shader有顶点着色器.几何着色器.片段着色器,这几个都是为光栅化图形渲染服务的,OpenGL 4.3之后新出了一个Compute Shader,用于通用计算并行加速,现在对其进行介绍 ...

  2. 27.t分布随机近邻嵌入t-SNE

    t分布随机近邻嵌入(t-distributed Stohastic Neighbor Embedding) 基本思路:为高维特征空间在二维平面(或三维超平面,不过基本上总是使用二维空间)上寻找一个投影 ...

  3. 二维数组中的查找(剑指offer_4)

    给定一个二维数组,其每一行从左到右递增排序,从上到下也是递增排序.给定一个数,判断这个数是否在该二维数组中. Consider the following matrix: [ [1, 4, 7, 11 ...

  4. MyBatis核心对象之StatementHandler

    MyBatis核心对象之StatementHandler StatementHandler ResultHandler ParameterHandler Executor org.apache.iba ...

  5. Codeforces Round #590 D. Distinct Characters Queries

    CF上给的标签是数据结构.但给的题解里的方法是很巧的暴力,用vector<set>维护每个字母出现的下标,每次修改加下标,擦下标.每次询问对每个字母分别lower_bound查找区间内是否 ...

  6. JVM内存模型与类加载机制

    一. java虚拟机的内存模型如图: 补习一下jvm内存模型中的各个组成部分 堆: 我们new出来的对象全部放在堆中,他是jvm所能够动态分配的最大的一块空间 优点: 内存动态分配,生命周期不必事先告 ...

  7. PAT 1009 Product of Polynomials 模拟

    This time, you are supposed to find A*B where A and B are two polynomials. Input Specification: Each ...

  8. Spring Boot Redis 解析

    redis使用示例 本示例主要内容 使用lettuce操作redis redis字符串存储(RedisStringController.java) redis对象存储(RedisObjectContr ...

  9. java基础(5):流程控制语句(switch)、数组

    1. 流程控制语句(续) 1.1 选择结构switch switch 条件语句也是一种很常用的选择语句,它和if条件语句不同,它只能针对某个表达式的值作出判断,从而决定程序执行哪一段代码.例如,在程序 ...

  10. iOS swift 带有attributeString的多行文本label

    class AttributeStringGenerator { var attributeString: NSMutableAttributedString! var lineSpacing: CG ...