标签：接口 api books https 序列化 restful drf

1.restful规范

1.数据的安全保障：url链接一般都采用https协议进行传输---》为了保证数据安全使用https协议传输-https是什么：http+ssl/tsl

2.接口中带aoi关键字
比如：-https://api.lqz.com/books
     -https://www.lqz.com/api/books    

3.多数据版本共存，一个接口可能有多个版本--》url链接中标识版本标识
-假设我们有个登录接口：开始只要用户名和密码 后来用户名，密码，验证码

4.数据既是资源，均使用名词（可用复数）--》接口尽量使用名词（并且尽量不出现动词）
-接口一般都是完成前后台数据的交互，交互的数据我们称之为资源
-接口形式比如：https://api.baidu.com/users
  			  https://api.baidu.com/books
-特殊的接口可以出现动词，因为这些接口一般没有一个明确的资源，或是动词就是接口的核心含义、https://api.baidu.com/login
- 都是应名词，没法区分增加，删除，修改，查询

5.资源操作由请求方式决定(method)
-操作资源一般都会涉及到增删改查，我们提供请求方式来标识增删改查动作
-获取数据： get请求
https://api.baidu.com/books -get请求：获取所有的书
    
-删除数据： delete 请求
   https://api.baidu.com/books/1  - delete请求：删除主键为1的书
        
-新增数据：post请求
 https://api.baidu.com/books    - post请求：新增一本书
        
-修改数据： put 请求
 https://api.baidu.com/books/1  - put请求：修改主键为1的书
-请求地址一样，通过请求方式决定对资源进行什么操作

6.url地址中带过滤参数
-获取动物园所有动物  127.0.0.1/api/v1/animals  --》get请求
-获取动物园所有哺乳类动物 127.0.0.1/api/v1/animals？type=哺乳类 --》get请求

7.响应带状态码
--http状态码：http://tools.jb51.net/table/http_status_code
    -1xx：表示请求正在处理，一般看不到
    -2xx： 表示请求处理成功， 有很多  200，201
    -3xx： 重定向  302 301
    -4xx： 客户端错误  403 404 
    -5xx ：服务端错误 

https://blog.csdn.net/li_chunlong/article/details/120787872

    -响应体中写状态码:咱们公司里有规范，在响应体中写状态码
        {code:100} 后期一般都会使用100  101  102 这种

8.返回错误信息--》响应体中带错误信息
{code:0       msg:"ok/用户名错误"}

9.返回结果，针对不同操作，服务器向用户返回的结果应该符合以下规范
GET 获取所有数据：返回资源对象的列表（数组）[{"name":"红楼梦" ，"price":99},{"name":"红楼梦"，"price":99}，{"name":"红楼梦","price":99}]
GET单个对象：返回单个资源对象：{"name"："红楼梦"，"price"：99}
POST新增对象：返回新生成的资源对象：{name：西游记，price：99}
PUT修改对象：返回完整的资源对象：{name：西游记，price：100}
DELETE删除：返回一个空文档

10.响应中带链接

2.序列化反序列化

# api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是[数据转换格式]，序列化可以分两个阶段：

# 序列化：把我们识别的数据转换成指定的格式提供给别人
-字典，列表-----》json格式存到文件中了
-列如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们 需要把数据进行序列化，变成字符串或者json数据，提供给别人
-read 读

#反序列化：就是别人提供的数据转换/还原成我们需要的格式
-列如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
-write 写

3.基于django原生编写的5个接口

以后写的接口，基本上都是5个接口及其变形
-查询所有
-查询单个
-新增一个
-修改一个
-删除一个

# 基于books单表为例，写5个接口
-创建book表
-表迁移
-录入假数据：直接录，后台管理录
-写查询所有接口--》遵循restful规范，使用cbv基于类的视图，更方便
-新增一个数据--》
-查询一个
-修改一个：put提交的数据，不能从requets.post中取
-删除一个

4.drf介绍和下载

drf全称：django rest framework 是一个建立在Django基础之上的Web应用开发框架，用drf可方便快速写出符合restful规范的接口

# 一般django都用最新版的上一个版本
# 注意：drf最新版支持到django3.x，不支持2.x(django2.x可以用最新版drf 只是安装时可能会有小问题)
#       下载drf会自动把django更新到最新版本，但是django我们一般不用最新版所以下载完drf再下载一下原版本的django即可

pip3 install djangorestframework -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com/simple/

drf使用

# 用drf快速编写5个接口（目前仅作了解）



#【models.py】

from django.db import models
# 创建模型类(Book表)
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)
    
——————————————————————————————————————————————————————————————
#【urls.py】

# 用drf写5个接口
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
# 这里的路径不需要加/ 会自动加
router.register('api/v1/books', views.BookView, 'books')  # 再起一个别名也叫books

urlpatterns = [
    path('admin/', admin.site.urls),
]

# 让两个列表相加(会将自动生成的路由加到urlpatterns列表中)
urlpatterns += router.urls

——————————————————————————————————————————————————————————————
# app01下新建文件【serializer.py】

# 继承serializers中的ModelSerializer
from rest_framework import serializers
# 导入表关系
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'
        
——————————————————————————————————————————————————————————————
# 【views.py】

# 不再继承View而是ModelViewSet
from rest_framework.viewsets import ModelViewSet
# 导入表关系
from .models import Book
# 导入新建的序列化类
from .serializer import BookSerializer
# 用drf快速编写5个接口
class BookView(ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

5.cbv源码分析

# 1 路由中写的：path('api/v1/books/', views.BookView.as_view())，第二个参数无论是fbv还是cbv放的都是函数内存地址
	-当请求来了，匹配成功会执行，views.BookView.as_view()(request)
    -views.BookView.as_view()执行结果是View的类方法as_view返回的结果是内层函数view，是个函数内层地址
    -本身请求来了，匹配成功，会执行view(request)
    def view(request, *args, **kwargs):
        return self.dispatch(request, *args, **kwargs)
    
    -self.dispatch  View类的方法
   	def dispatch(self, request, *args, **kwargs):
        # request.method请求方式转成小写，必须在列表中才能往下走
        if request.method.lower() in self.http_method_names:
            # 反射，去self【视图类的对象：BookView】，去通过get字符串，反射出属性或方法
            # 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)

标签：接口,api,books,https,序列化,restful,drf
From： https://www.cnblogs.com/lvqingmei/p/17080804.html

restful规范、序列化与反序列化与drf下载及使用