drf day02 restful规范十条、drf安装与使用（听个响先）、基于django原生编写五个接口

昨日内容补充

ajax 做交互时，不指定编码就是普通的urlencoded格式，要传文件就改那两个参数为false就变为form-date，要传json就改 contentType:'application/json'

浏览器展示的就是响应体Body的内容给渲染了的

一、restful规范（很重要，面试常问）

RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

事实上，我们使用任何一个框架都可以写出符合restful规范的API接口。

#抓包工具 : fiddler,charles 
#不但可以抓浏览器发出去的包，也可以抓手机发出去的包，抓到了包就能看到json格式的数据

1.十条规范

1.数据的安全保障：url链接一般都采用https协议进行传输

注：采用https协议，可以提高数据交互过程中的安全性，比http安全

2.接口特征表现，一看就知道是个api接口

路飞的接口：https://api.luffycity.com/api/v1/course/free/

3.多数据版本共存

- 在url链接中标识数据版本
- https://api.baidu.com/v1
- https://api.baidu.com/v2
注：url链接中的v1、v2就是不同数据版本的体现（只有在一种数据资源有多版本情况下）

4.数据即是资源，均使用名词（可复数）——重要

总结就是拿资源的英文建议缩成资源这个名词，拿这个动词去掉！

- 接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
      - https://api.baidu.com/users
      - https://api.baidu.com/books
      - https://api.baidu.com/book

      注：一般提倡用资源的复数形式，在url链接中建议不要出现操作资源的动词，错误示范：			https://api.baidu.com/delete-user
    - 特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义

      - https://api.baidu.com/place/search
      - 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 - 发patch请求：局部修改主键为1的书
      - https://api.baidu.com/books/1 - 发delete请求：删除主键为1的书

6.过滤，通过在url上传参的形式传递搜索条件

- https://api.example.com/v1/zoos?limit=10：指定返回记录的数量
- https://api.example.com/v1/zoos?offset=10：指定返回记录的开始位置
- https://api.example.com/v1/zoos?page=2&per_page=100：指定第几页，以及每页的记录数
- https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序
- https://api.example.com/v1/zoos?animal_type_id=1：指定筛选条件

7.响应状态码

7.1 正常响应
    - 响应状态码2xx
      - 200：常规请求
      - 201：创建成功  #分的更细了
   7.2 重定向响应
    - 响应状态码3xx
      - 301：永久重定向
      - 302：暂时重定向
   7.3 客户端异常
    - 响应状态码4xx
      - 403：请求无权限
      - 404：请求路径不存在   
      - 405：请求方法不存在  # 比如不支持post请求
	7.4 服务器异常
    - 响应状态码5xx
      - 500：服务器异常
   4代表客户端出问题，5代码服务端出问题

还有自己创的一套，类似{'code'：1001}这种

8.错误处理，应返回错误信息，error当做key

  {
        error: "无权限操作"  # message 也行
    }
    
 类似以前写Bbs时写的Msg返回错误信息

9.返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范

这个不一定要遵循，太麻烦了

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象，一般返回字典
POST /collection：返回新生成的资源对象   
PUT /collection/resource：修改完返回完整的资源对象
PATCH /collection/resource：修改完返回完整的资源对象
DELETE /collection/resource：返回一个空文档  {}这样

10.响应回来的json数据可以带地址（链接），就能看到图片啊之类的

 # Hypermedia API，RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么
        {
            "status": 0,
            "msg": "ok",
            "results":[
                {
                    "name":"肯德基(罗餐厅)",
                    "img": "https://image.baidu.com/kfc/001.png"
                }
                ...
                ]
        }

二、序列化与反序列化

后端查询数据转换后发给前端，叫做序列化，json数据就是字符串

————read过程

前端传过来的数据，还原成后端需要的格式，后端一般是需要对象，把前端传过来的json（一般是这种格式数据）转成对象存到数据库中就是反序列化

————write过程

三、drf的安装和简单使用

1.安装

# 用豆瓣源安装
pip install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/
    
这种方法会装到最新的 djangorestframework版本，但是会带着给django升级到4.x，我们需要给django又降级回去
pip install django==2.2.22 -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/
    #版本号按你以前用习惯了版本号即可

如果是老版本django就下载回退两三个版本

drf最新版本支持django 3.x

2.使用

pycharm开一个django项目

1.先在setting.py里面注册
INSTALLED_APPS = [
'rest_framework'
]
2.在models.py中写表模型
class Book(models.Model):
    nid=models.AutoField(primary_key=True)
    name=models.CharField(max_length=32)
    price=models.DecimalField(max_digits=5,decimal_places=2)
    author=models.CharField(max_length=32)
3. 新建一个序列化类（暂时不懂）
app01中新建一个ser的Py文件
from rest_framework.serializers import ModelSerializer
from app01.models import Book


class BookModelSerializer(ModelSerializer):
    class Meta:
        model = Book
        fields = "__all__"
4.在视图中写视图类
from rest_framework.viewsets import ModelViewSet
from .models import Book
from .myser import BookModelSerializer


class BooksViewSet(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookModelSerializer
5.写路由关系
from django.contrib import admin
from django.urls import path
from rest_framework.routers import SimpleRouter
from app01 import views

router = SimpleRouter()
router.register('books', views.BooksViewSet)
urlpatterns = [
    path('admin/', admin.site.urls),
]
urlpatterns += router.urls
6.更新数据库后启动项目



删除单一或者修改单一的api要给Pk后面加/，比较奇怪

四、基于django原生编写五个接口

热重启，c +s 可以重启django项目

以后写的接口，基本上都是5个接口及变形
	-查询所有   get >>books
    -查询单个	get >>books/1
    -新增一个	post >>book
    -修改一个   put >>book/1
    -删除一个	delete >>book/1
    
后期写的都是CBV 而不是FBV，FBV写多了太乱

1.查询所有书籍

Jsonresponse(数据（需要是列表或者字典形式），safe=False，如果要中文正常编码加一个字典)
>>>根据Jsonresponse源码那个字典一加就相当于json.dumps(xxx,ensure_ascii=False)

2.增加一本书，注意url只能发form-date 或者urlencoded请求，不能发Json（reques.POST.get拿不到数据）
	#记得注一下那个中间件哦

 	json写数据的时候，最后不要留逗号
	json格式编码提交的数据，不能从request.POST.get()里面拿  
    
    #如果用json发数据怎么写view
        def post(self, request):
        res = request.body
        name = request.POST.get('name')
        if not name:
            name = json.loads(res.decode('utf-8')).get('name')
            
        price = request.POST.get('price')
        if not price:
            price = json.loads(res.decode('utf-8')).get('price')
            
        publish = request.POST.get('publish')
        if not publish:
            publish = json.loads(res.decode('utf-8')).get('publish')
            
        book = Book.objects.create(name=name, price=price, publish=publish)

        return JsonResponse({'code': 1000})
    
3.查询一本书或者删除一本书

写针对Pk值的路由时，建议就用转换器，re_path用起来不太好，太老了，正则能匹配的范围比较广
/<int:pk>
注意:要写查询单个时，视图层中前面写过的cbv的类用过了，要新搞一个

代码：
class BookOtherView(View):
    def get(self, request, pk):
        # 找到这本书
        book_obj = Book.objects.filter(pk=pk).first()

        return JsonResponse(
            {'id': book_obj.pk, 'name': book_obj.name, 'price': book_obj.price, 'publish': book_obj.publish})    
    
    def delete(self, request, pk):
        book_obj = Book.objects.filter(pk=pk).delete()
        return JsonResponse({})
    
4.修改一本书比较难
put是一个坑，传过来的数据不能通过request.POST.get那拿到
所以要用request.body拿
前端传数据时用json编码格式传过来
 def put(self, request, pk):
        book_obj = Book.objects.filter(pk=pk).first()
        print(request.body)
        book_dict = json.loads(request.body)
        # 把数据更新
        book_obj.name = book_dict.get('name')
        book_obj.price = book_dict.get('price')
        book_obj.publish = book_dict.get('publish')
        book_obj.save()

        return JsonResponse(
            {'id': book_obj.pk, 'name': book_obj.name, 'price': book_obj.price, 'publish': book_obj.publish})

五、CBV源码剖析

先回顾一下CBV我们以前怎么写的

#views
from django import views # 要导入模块先

class Myfunc(views.View): # 必须继承这个
    def get(self,request):
        return HttpResponse('CBV GET方式')
    def post(self,requset):
        return HttpResponse('CBV,POST方式')
    
#urls
path('func/',views.Myfunc.as_view() ) # 必须.as_view()

源码剖析可以见以前写过的博客
https://www.cnblogs.com/wznn125ml/p/16980743.html#autoid-h4-5-0-6

今天学的一些其他的东西

1.在项目中导模型表时，可以不用from app01.models import Book的形式

用from .models import Book 相对路径导入

posted @ 2023-01-31 16:36 yiwufish 阅读(175) 评论(0) 收藏举报

刷新页面返回顶部

wznn125ml