django-rest framework 接口规范 原生django接口、单查群查 postman工具 CBV源码解析

内容了解

"""
1、接口:什么是接口、restful接口规范
2、CBV生命周期源码 - 基于restful规范下的CBV接口
3、请求组件、解析组件、响应组件
4、序列化组件(灵魂)
5、三大认证(重中之重):认证、权限(权限六表)、频率
6、其他组件:过滤、筛选、排序、分页、路由
"""
# 难点:源码分析

一、接口

1.什么是

接口:联系两个物质的媒介,完成信息交互
web程序中:联系前台页面与后台数据库的媒介
web接口组成:
    url:长得像放回数据的url链接
    请求参数:前台按照指定的key提供数据给后台
    响应数据:后台与数据库交互后将数据反馈给前台

2.restful接口规范

接口规范:就是为了采用不同的后台语言,也能使用同样的接口获取到同样的数据

如何写接口:接口规范是 规范化书写接口的,写接口要写 url、响应数据

注:如果将请求参数也纳入考量范围,那就是在写 接口文档

两大部分:

#1.url

1) 用api关键字标识接口url
    api.baidu.com | www.baidu.com/api

2) 接口数据安全性决定优先选择https协议

3) 如果一个接口有多版本存在,需要在url中标识体现
    api.baidu.com/v1/... | api.baidu.com/v2/...

4) 接口操作的数据源称之为 资源,在url中一般采用资源复数形式,一个接口可以概括对该资源的多种操作方式,(之前是FBV,一对一,现在CBV,接口针对一个类,类下面有多个方法)
    api.baidu.com/books | api.baidu.com/books/(pk)

5) 请求方式有多种,用一个url处理如何保证不混乱 - 通过请求方式标识操作资源的方式
    /books        get            获取所有
    /books        post        增加一个(多个)
    /books/(pk)    delete        删除一个
    /books/(pk)    put            整体更新一个
    /books/(pk)    patch        局部更新一个

6) 资源往往涉及数据的各种操作方式 - 筛选、排序、限制(查询和西有关的,价格降序,3条)
    api.baidu.com/books/?search=西&ordering=-price&limit=3

#2.响应数据

1) http请求的响应会有响应状态码,接口用来返回操作的资源数据,可以拥有 操作数据结果的 状态码
    status  0(操作资源成功)  1(操作资源失败)  2(操作资源成功,但没匹配结果)
    注:资源状态码不像http状态码,一般都是后台与前台或是客户约定的

2) 资源的状态码文字提示
    status  ok    ‘账号有误‘  ‘密码有误‘  ‘用户锁定‘

3) 资源本身
    results
    注:删除资源成功不做任何数据返回(返回空字符串)

4) 不能直接返回的资源(子资源、图片、视频等资源),返回该资源的url链接

#3.示例

url:https://api.baidu.com/v1/books?ordering=-price&limit=3
        get|post|put|patch|delete
        {
            ‘status‘: 0,
            ‘msg‘: ‘ok‘,
            ‘results‘: [
                {
                    ‘title‘: ‘西游记‘,
                    ‘img‘: ‘https://api.baidu.com/media/xyj.png‘
                }
            ]
        }

二、基于restful规范的原生Django接口

1.创建django项目,app名称为api
2. 主路由 路由分发:url.py
from django.conf.urls import url, include
from django.contrib import admin
?
?
urlpatterns = [
    url(r‘^admin/‘, admin.site.urls),
    # 路由分发
    url(r‘^api/‘, include(‘api.urls‘))
]
3. api组件的子路由:api/url.py
from django.conf.urls import url
?
from . import views
urlpatterns = [
    url(r‘^books/‘, views.Book.as_view()),  #群查
    url(r‘^books/(?P<pk>.*)/$‘, views.Book.as_view()),  #单查
]
4.views

5. 模型层:model.py
from django.db import models
?
class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)
?
    class Meta:
        db_table = ‘old_boy_book‘
        verbose_name = ‘书籍‘
        verbose_name_plural = verbose_name
?
    def __str__(self):
        return ‘《%s》‘ % self.title
6. 后台层 注册:admin.py
from django.contrib import admin
?
from . import models
?
admin.site.register(models.Book)
7. 数据库迁移
>: python manage.py makemigrations  #数据库迁移
>: python manage.py migrrate
?
>: python manage.py createsuperuser  #创建超级用户,开始admin后台管理
8. 原生django单查群查  完整视图层:views.py

    class Book(View):
        def get(self, request, *args, **kwargs):
            pk = kwagrs.get(‘pk‘)
            if pk:
                # 单查
            else:
                # 群查
        def post(self, request, *args, **kwargs):
            # 增
        def delete(self, request, *args, **kwargs):
            # 删
        def put(self, request, *args, **kwargs):
            # 整体改
        def patch(self, request, *args, **kwargs):
            # 局部改

示例

from django.http import JsonResponse
?
from django.views import View
from . import models
?
?
# 六大基础接口:获取一个 获取所有 增加一个 删除一个 整体更新一个 局部更新一个
# 十大接口:群增 群删 整体改群改 局部改群改
class Book(View):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get(‘pk‘)
        if not pk:  # 群查,子路由中有对应规则,url没有指定pk就是全都要127.0.0.1:8000/api/books/
            # 操作数据库
            book_obj_list = models.Book.objects.all()
            # 序列化过程
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic[‘title‘] = obj.title
                dic[‘price‘] = obj.price
                book_list.append(dic)
            # 响应数据
            return JsonResponse({
                ‘status‘: 0,
                ‘msg‘: ‘ok‘,
                ‘results‘: book_list
            }, json_dumps_params={‘ensure_ascii‘: False})  //防止转码,不然汉字会转码
        else:  # 单查,127.0.0.1:8000/api/books/1/ 查看第一个
            book_dic = models.Book.objects.filter(pk=pk).values(‘title‘, ‘price‘).first()
            if book_dic:
                return JsonResponse({
                    ‘status‘: 0,
                    ‘msg‘: ‘ok‘,
                    ‘results‘: book_dic
                }, json_dumps_params={‘ensure_ascii‘: False})
            return JsonResponse({
                ‘status‘: 2,
                ‘msg‘: ‘无结果‘,
            }, json_dumps_params={‘ensure_ascii‘: False})
?
?
    # postman可以完成不同方式的请求:get | post | put ...
    # postman发送数据包有三种方式:form-data | urlencoding | json
    # 原生django对urlencoding方式数据兼容最好
    def post(self, request, *args, **kwargs):
        # 前台通过urlencoding方式提交数据
        try:
            book_obj = models.Book.objects.create(**request.POST.dict())
            if book_obj:
                return JsonResponse({
                    ‘status‘: 0,
                    ‘msg‘: ‘ok‘,
                    ‘results‘: {‘title‘: book_obj.title, ‘price‘: book_obj.price}
                }, json_dumps_params={‘ensure_ascii‘: False})
        except:
            return JsonResponse({
                ‘status‘: 1,
                ‘msg‘: ‘参数有误‘,
            }, json_dumps_params={‘ensure_ascii‘: False})
?
        return JsonResponse({
            ‘status‘: 2,
            ‘msg‘: ‘新增失败‘,
        }, json_dumps_params={‘ensure_ascii‘: False})

三、CBV请求生命周期源码回顾 (之前总结过)

1.路由

2. as_view和view

3.dispatch

任务分发其实是调用了我们写的类中的方法,将路由来的参数传递给她们,返回相应数据给前端

4.views.py

四、Postman接口工具

官网下载安装

get请求,携带参数采用Params

post等请求,提交数据包可以采用三种方式:form-date、urlencoding、json

所有请求都可以携带请求头

上方views.py中有后端代码

#百度测试接口  接口文档
        method: GET
        url: https://api.map.baidu.com/place/v2/search
        params:
            ak: 6E823f587c95f0148c19993539b99295
            region: 上海、郑州、杭州等
            query: 肯德基、公园等
            output: json

原文地址:https://www.cnblogs.com/xp1315458571/p/11679930.html

时间: 2024-10-07 02:01:23

django-rest framework 接口规范 原生django接口、单查群查 postman工具 CBV源码解析的相关文章

Queue(队列)接口和其实现类PriorityQueue(优先级队列)源码解析

前面介绍的Stack是新进后出,而Queue是先进先出的 1.Queue结构 public interface Queue<E> extends Collection<E> { boolean add(E e); boolean offer(E e); E remove(); E poll(); E element(); E peek(); } Queue是一个接口. 2.PriorityQueue源码分析 PriorityQueue是一个优先队列,和先进先出的队列的区别是: 优先

Django APIView源码解析

APIView用法: 在Django之 CBV和FBV中,我们是分析的from django.views import View下的执行流程,以下是代码 from django.views import View class IndexView(View): def get(self,request, *args, **kwargs): return HttpResponse("ok") def dispatch(self, request, *args, **kwargs): ret

Django框架 --CBV源码分析、restful规范、restframework框架

一.CBV源码分析 1.url层的使用CBV from app01 import views url(r'book/',views.Book.as_view()) 2.as_view方法 as_view是一个类方法,实际上是一个闭包函数(内层函数包含对外层作用域的使用) 请求来了以后,调用as_view方法,调用函数中的view方法,view方法是调用了dispatch方法 @classonlymethod def as_view(cls, **initkwargs): def view(req

django中cbv源码和restful规范

1 django 请求声明周期 -先进入实现了wsgi协议的web服务器---->进入django--->中间件--->路由--->视图--->取模板,取数据,用数据渲染模板--->返回模板的字符串--->在浏览器上看到页面了 2 开发模式(前后端分离和前后端不分离) -前后端不分离项目 -前后端分离项目 前端和后端通过json格式数据交互 3 cbv 源码分析 -FBV和CBV -执行流程: -路由如果这么配置:url(r'^test/', views.Test

DRF--十大接口方法:单查群查,单删群删,单增群增,整体单改群改,局部单改群改

from rest_framework.views import APIView from rest_framework.response import Response from . import models, serializers from .response import APIResponse # 出版社群查 class PublishAPIView(APIView): def get(self, request, *args, **kwargs): publish_query =

Django settings源码解析

Django settings源码 Django中有两个配置文件 局部配置:配置文件settings.py,即项目同名文件夹下的settings.py文件 全局配置:django内部全局的配置文件settings.py,需要导入才能看到 from django.conf import settings # 是一个对象,单例模式 from django.conf import global_settings # 真正的默认配置文件 特点: 先加载全局配置,再加载局部配置,以局部优先 源码解析 点进

Spring-cloud &amp; Netflix 源码解析:Eureka 服务注册发现接口 ****

http://www.idouba.net/spring-cloud-source-eureka-client-api/?utm_source=tuicool&utm_medium=referral *************************** 先关注下netflix eureka server 原生提供的接口.https://github.com/Netflix/eureka/wiki/Eureka-REST-operations 这是对非java的服务使用eureka时可以使用的r

IdentityServer4源码解析_5_查询用户信息接口

目录 IdentityServer4源码解析_1_项目结构 IdentityServer4源码解析_2_元数据接口 IdentityServer4源码解析_3_认证接口 IdentityServer4源码解析_4_令牌发放接口 IdentityServer4源码解析_5_查询用户信息接口 [IdentityServer4源码解析_6_结束会话接口] [IdentityServer4源码解析_7_查询令牌信息接口] [IdentityServer4源码解析_8_撤销令牌接口] 协议简析 UserI

68:Scala并发编程原生线程Actor、Cass Class下的消息传递和偏函数实战解析及其在Spark中的应用源码解析

今天给大家带来的是王家林老师的scala编程讲座的第68讲:Scala并发编程原生线程Actor.Cass Class下的消息传递和偏函数实战解析 昨天讲了Actor的匿名Actor及消息传递,那么我们今天来看一下原生线程Actor及CassClass下的消息传递,让我们从代码出发: case class Person(name:String,age:Int)//定义cass Class class HelloActor extends Actor{//预定义一个Actor  def act()