restful规范

# restful是一种定义web API接口的设计风格,适用于前后端分离的应用模式中

# 关于restful的10个规范
-1.数据的安全保障,通常使用https协议(http+ssl/tsl)
url链接一般都采用https协议进行传输,https协议可以提高数据交互过程中的安全性
-2.接口中带api标识
https://api.lqz.com/books
https://www.lqz.com/api/books
-3.多版本共存,路径中带版本信息
https://api.lqz.com/v1/login
https://www.lqz.com/api/v2/login
-4.数据就是资源,均使用名词,尽量不出现动词(核心)
- 1).接口一般都是前后台数据的交互,交互的数据我们称之为资源
- 2).接口形式: https://api.baidu.com/users
https://api.baidu.com/books
- 3).特殊的接口可以出现动词,因为这些接口一般没有一个明确的资源,或者动词就是接口的核心含义
https://api.baidu.com/login
-5.资源操作由请求方式决定(method)
- 我们一般提供请求方式来标识增删改查动作
https://api.baidu.com/books - get请求:获取所有书
https://api.baidu.com/books/1 - get请求:获取主键为1的书
https://api.baidu.com/books - post请求:新增一本书书
https://api.baidu.com/books/1 - put请求:修改主键为1的书
https://api.baidu.com/books/1 - delete请求:删除主键为1的书
-6.在请求地址中带过滤条件
https://api.baidu.com/books?name=xxx&price=xx
-7.响应中状态码:两套
1).http响应状态码:
1xx:请求正在处理
2xx:成功响应
3xx:重定向
4xx: 客户端错误
5xx:服务端错误
2).公司内部自己规定的状态码:
放在响应体里 : {code:0}
-8.返回数据中带错误信息
{
code:0
msg:"ok/用户名错误"
}
-9.返回的结果应该符合以下规范
-1).GET 获取所有数据:返回资源对象的列表(数组)[{name:红楼梦,price:99},{name:红楼梦,price:99},{name:红楼梦,price:99}]
-2).GET 单个对象:返回单个资源对象:{name:红楼梦,price:99}
-3).POST 新增对象:返回新生成的资源对象:{name:西游记,price:99}
-4).PUT 修改对象:返回完整的资源对象 :{name:西游记,price:100}
-5).DELETE 删除:返回一个空文档
-10.响应数据中带链接

序列化反序列化

# 序列化:把我们识别的数据转换成指定格式提供给别人
- read
字典,列表以json格式存到文件中
例:在django中获取到的数据默认是模型对象,无法直接提供给前端等使用,所以需要把数据序列化,变成字符串或json数据,提供给别人
# 反序列化:把别人提供的数据转换/还原成我们需要的格式
- write
例:前端js提供过来的json数据,对于python就是字符串,我们需要反序列化成模型类对象,才能将其保存到数据库中

基于django原生编写五个接口

# 以后所遇到的所有的接口都是五个接口及其变形
1.查询单个
2.查询所有
3.新增单个
4.修改单个
5.删除单个
# 给予books表写5个接口
-1.创建book表
-2.表迁移
-3.录入假数据:直接录,后台管理录
-4.写查询所有接口---》遵循restful规范,使用cbv
-5.新增一个数据---》
-6.查询一个
-7.修改一个:put提交的数据,不能从requets.POST中取
-8.删除一个
# 代码实操
- 1.views.py
from django.http import JsonResponse
from django.views import View
from .models import Book
import json class BookView(View):
def get(self,request):
books = Book.objects.all()
book_list = []
for book in books:
book_list.append({'name': book.name, 'price':book.price, 'publish':book.publish})
return JsonResponse(book_list, safe=False, json_dumps_params={'ensure_ascii': False}) def post(self,request):
name = request.POST.get('name')
price = request.POST.get('price')
publish = request.POST.get('publish')
book = Book.objects.create(name=name,price=price,publish=publish)
return JsonResponse({'name':book.name, 'price':book.price,'publish':book.publish}) class BookDetailView(View):
# 获取单条
def get(self,request,pk):
book = Book.objects.filter(pk=pk).first()
return JsonResponse({'id':book.id,'name':book.name,'price': book.price, 'publish':book.publish})
# 修改单条
def put(self,request,pk):
# 先查到要改的
book = Book.objects.filter(pk=pk).first()
print(request.body)
book_dic = json.loads(request.body)
book.name = book_dic.get('name')
book.price = book_dic.get('price')
book.publish = book_dic.get('publish')
book.save() # 删除单条
def delete(self,request,pk):
Book.objects.filter(pk=pk).delete()
return JsonResponse(data={}) -2.urls.py
urlpatterns = [
path('api/v1/books/', views.BookView.as_view())
]

drf介绍与快速使用

# drf 全称djangorestramework,可以帮助我们快速实现符合restful规范的接口
# drf最新支持到djagno 3.x ,最新不支持2.x
# 安装drf
pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/
# 由于你是django2.x 它发现它不支持,它会自动写在dajgno,安装最新的django 4.x
# drf编写5个接口

- 1.views.py:
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer class BookView(ModelViewSet):
queryset = Book.objects.all()
serializer_class = BookSerializer - 2.urls.py
from django.contrib import admin
from django.urls import path
from drf01 import views from rest_framework.routers import SimpleRouter router =SimpleRouter()
router.register('books',views.BookView, 'books') urlpatterns = [
path('admin/', admin.site.urls),
]
urlpatterns += router.urls - 3.serializer.py
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
class Meta:
model=Book
fields = '__all__'

cbv源码分析

# 1.路由中写的:path('api/v1/books/',views.BookView.as_view()),
第二个参数无论是fbv还是cbv放的都是函数内存地址
- 1.当请求来了。匹配成功就会成功执行view(request)
def view(request, *args, **kwargs):
return self.dispatch(request, *args, **kwargs)
- 2. self.dispatch view类方法
def dispatch(self, request, *args, **kwargs):
# request.method请求方式转成小写,必须在列表中才能往下走
if request.method.lower() in self.http_method_names:
# 反射,去self[视图类的对象:BookView,通关get字符串,反射出属性或方法]
handler = getattr(self, request.method.lower(), self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
# BookView的get方法,加括号,传入request
return handler(request, *args, **kwargs)

最新文章

  1. Visual Studio 2015 各版本对比及下载地址
  2. 【Java EE 学习 24 上】【注解详解】
  3. Bootstrap学习之起步
  4. 高精度快速预览打开dwg文件的CAD控件CAD Image DLL介绍及下载
  5. linux下解压war文件命令
  6. 使用本地phpmyadmin管理远程数据库
  7. AutoMapper映射ExpressionTree
  8. 【转】Google推荐的命名规则——Android图片资源
  9. Java [Leetcode 292]Nim Game
  10. CI框架篇之模型篇--AR操作(2)
  11. 关于fork有意思的两道题目
  12. 物理DG主备库切换时遇到ORA-16139: media recovery required错误
  13. 基于visual Studio2013解决算法导论之009快速排序随机版本
  14. oracle 行专列
  15. 17. ZooKeeper常见的分布式系统任务——屏障
  16. Caffe源码理解1:Blob存储结构与设计
  17. [Swift]LeetCode844. 比较含退格的字符串 | Backspace String Compare
  18. Go语言学习笔记(五) [函数]
  19. 《C#并发编程经典实例》学习笔记—异步编程关键字 Async和Await
  20. Navicat Premium 12 破解(MySQL、MariaDB、MongoDB、SQL Server、SQLite)

热门文章

  1. 七、25.创建user子分支并把代码推送到码云仓库中
  2. Mybatis 中传入List实现 批量插入、批量更新、批量删除
  3. 关于MounRiver编译器配置的若干问题
  4. JS日期时间增加减少
  5. linux忘记密码-进入单用户模式修改密码
  6. OpenSSL测试-SM3
  7. OS复盘
  8. shell_Day07
  9. Linux下aria2详细配置,以及接管浏览器下载项
  10. Linux内核红黑树2—移植笔记