首页 > 其他分享 >今日内容 API接口和drf的使用

今日内容 API接口和drf的使用

时间:2022-09-23 20:26:38浏览次数:96  
标签:请求 get 接口 --- API import 序列化 drf

  • 前后端开发模式

详细见博客链接:https://www.cnblogs.com/liuqingzheng/p/10900502.html

补充:

前后端混合开发

使用模板语法渲染模板
后端人员要通过前端写好的html页面套模板语法
前后端不分离

前后端分离,

前端由前端人员编写,写的过程中使用mock数据
后端人员只负责写接口(API接口),使用postman接口测试工具测试最后前后端联调项目
前后端分离

  • API接口

通过网络,规定了前后台信息交互规则的url链接,也就是前后台信息交互的媒介

API接口形式:

# url:长得像返回数据的url链接
https://api.map.baidu.com/place/v2/search
# 请求方式: get,post,put,patch,delete
采用get方式请求上方接口
#请求参数: json或xml格式的ket_value类型数据
ak:6E823f587c95f0148c19993539b99295
        region:上海
        query:肯德基
        output:json
#响应结果:json或xml格式的数据
  • 接口测试工具postman

使用postman软件做接口测试本质就是模拟发送http请求,不可以在浏览器中测试
官网下载:https://www.postman.com/downloads/
安装后学习使用即可:

  • restful规范

REST全称是Representational State Transfer,中文意思是表述:表征性状态转移, 它首次出现在2000年Roy Fielding的博士论文中
RESTful是一种定义Web API接口的设计风格,尤其适用于前后端分离的应用模式中

restful规范有10点---》规范,公司有自己的风格规范
1 数据的安全保障:url链接一般都采用https协议进行传输 --->为了保证数据安全使用https协议传输
2 接口中带API关键词
3 多数据版本共存,一个接口可能有多个版本---》url链接中标识版本标识
假设咱们有个登录接口:开始只要用户名和密码 后来用户名,密码,验证码
4 数据即是资源,均使用名词(可用复数)---》接口尽量使用名词
都是用名词,没法区分是增加,删除,修改,查询
5 资源操作由请求方式决定

    	-获取数据:get请求
        -删除数据:delete请求
        -新增数据:post请求
        -修改数据:put,patch请求
        -请求地址一样,通过请求方式决定对资源进行什么操作

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
xx:表示请求正在处理,一般看不到
2xx: 表示请求处理成功, 有很多 200,201
3xx: 重定向 302 301
4xx: 客户端错误 403 404
5xx :服务端错误
响应体中写状态码:咱们公司里有规范,在响应体中写状态码
{code:100}
8 返回错误信息--->响应体中带错误信息
{code:100,msg:成功}
9 返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范

    GET /collection:返回资源对象的列表(数组)[{},{}]
    GET /collection/resource:返回单个资源对象 {}
    POST /collection:返回新生成的资源对象     {}
    PUT /collection/resource:返回完整的资源对象 {}
    PATCH /collection/resource:返回完整的资源对象 {}
    DELETE /collection/resource:返回一个空文档
获取所有:{code:100,msg:成功,data:[{name:水浒传,price:99},{name:西游记,price:88}]}
获取单条:{code:100,msg:成功,data:{name:水浒传,price:99}}
新增数据:{code:100,msg:新增成功,data:{name:西游记,price:99}}
修改数据:{code:100,msg:修改成功,data:{name:西游记v2版本,price:99}}
删除数据:{code:100,msg:删除成功}

10 响应中带链接

  • 序列化与反序列化

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

-序列化: 把我们识别的数据转换成指定的格式提供给别人
   例如:我们在django中获取到的数据默认是模型对象(queryset),但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。

-反序列化:把别人提供的数据转换/还原成我们需要的格式

  • djangorestframework使用

使用django这个web框架,开发前后端分离项目(模板渲染),只写接口
使用JsonResponse返回即可---》原生django
djangorestframework方便咱们快速写出符合restful规范的接口

写接口:总共就5个及这5个的变形

    -获取所有 get
    -获取单个 get
    -新增一条 post
    -修改一条 put/patch
    -删除一条 delete

对于book表,快速实现这5个接口
安装drf:pip3 install djangorestframework
通过postman测试

url.py

from django.contrib import admin
from django.urls importpath
from rest_framwork.routers import SimpleRouter
from app01 import views

router = SimpleRouter()
router.register('books',view.BookView)
urlpatterns = [
      path('admin/', admin.site.urls),
]
urlpatterns += router.urls

views.py

from .models import Book
from rest_framework.viewsets import ModelViewSet
from .serializer import BookSerializer

class BookView(ModelViewSet):
     queryset = Book.objects.all()
     serializer_class = BookSerializer

models.py

from django.db import models

class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    publish = models.CharField(max_length=32)

serializer.py

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers,ModelSerializer):
   class Meta:
        model = Book
        fields = '__all__'
  • cbv 源码分析

# 以后都写cbv,都写基于类的试图
# cbv写好后,路由配置如下
# 第一个参数是路径,第二个参数是试图函数的内存地址(视图类执行as_view这个类方法,把它执行完,结果放在第二个参数上:我们猜执行完的结果是个函数内存地址)
	path('test/', views.TestView.as_view()),
    
# 去找as_view,去TestView类中找,找不到,没有,去父类中找View
        @classonlymethod
        def as_view(cls, **initkwargs):
            def view(request, *args, **kwargs):
                return self.dispatch(request, *args, **kwargs)
            return view
# 当请求来了,路由匹配成功,会执行view(request)--->本质执行self.dispatch(request, *args, **kwargs)
# 去View中找到了dispatch
def dispatch(self, request, *args, **kwargs):
            # 请求方式转成小写,假设 get 请求,符合if条件
            if request.method.lower() in self.http_method_names:
                # 反射 getattr(对象,'字符串','默认值')
                # self是TestView的对象
                # handler 就是TestView类的get方法
                handler = getattr(self, 'get', self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed
            return handler(request, *args, **kwargs)  # get(request)

标签:请求,get,接口,---,API,import,序列化,drf
From: https://www.cnblogs.com/tai-yang77/p/16724096.html

相关文章

  • 集合.Set子接口
    Set子接口特点:无序、无下标、元素不可重复方法:全部继承自Collection中的方法Set实现类HashSet【重点】:基于HashCode实现元素不重复当存入元素的哈希码相同时,会调......
  • 【2022-09-23】DRF入门到入土(一)
    drf入门规范一、web应用模式web应用模式分为两种,一种是前后端不分离,一种是前后端分离前后端不分离前后端分离二、API接口为了在团队内部形成共识、防止......
  • 前后端分离 drf之一
    API接口前后端分离的开发模式:客户端和服务端采用restfulAPI的交互方式进行交互前后端代码库分离,前端代码可以进行mock测试能够独立开发和测试后端则用postman接口测......
  • drf学习笔记
    今日内容概要前后端开发模式API接口接口测试工具postmanrestful规范序列化和反序列化djangorestframework快速使用cbv源码分析今日内容详细前后端开发模式前后......
  • 【C#】接口的基本概念
    目录基本什么是接口接口与抽象类的区别抽象类接口实例设计接口基本什么是接口C#接口(interface)是:用来定义一种程序的协定实现接口的类或者结构要与接口的定义严格一致。......
  • Feign调用第三方http接口 (摘抄)
    我们平常在开发的时候,经常会碰到调用第三方的接口,这个时候我们可以使用httpClient或者restTemplate,但是这两种方式相比较与Feign调用,都会麻烦一点儿。Feign是声明式服务调......
  • layui 数据表格使用python django提供的数据接口
    数据库新建表 fromdjango.dbimportmodels#Createyourmodelshere.classHost(models.Model):hostname=models.CharField(max_length=32,verbose_name......
  • 微服务系列之Api文档 swagger整合
    1.前言微服务架构随之而来的前后端彻底分离,且服务众多,无论是前后端对接亦或是产品、运营翻看,一个现代化、规范化、可视化、可尝试的文档是多么重要,所以我们这节就说说......
  • API接口、接口测试工具postman、restful规范、序列化与反序列化、djangorestframework
    API接口通过网络,规定了前台后台信息交流规则的url链接,也就是前后台信息交互的媒介API接口的样子url:长得像返回数据的url链接https://api.map.baidu.com/place/v2/s......
  • 使用 Docker 的个性化排名 API
    使用Docker的个性化排名API在这篇文章中,我们将探讨如何设置和使用Metarank的个性化排名API和Redis持久化和码头工人撰写.数据准备Metarank是一个开源个......