Django rest framework 基础

1.1 什么是RESTful

  1. REST与技术无关,代表的是一种软件架构风格(REST是Representational State Transfer的简称,中文翻译为“表征状态转移”)

  2. REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识

  3. 所有的数据,不过是通过网络获取的还是操作(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性

  4. 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)

1.2 RESTful API设计规范

  参考地址: http://www.cnblogs.com/wupeiqi/articles/7805382.html

   1、API与用户的通信协议,总是使用HTTPs协议

   2、域名 

    1)子域名方式

      https://api.example.com                         尽量将API部署在专用域名(会存在跨域问题)

      https://www.example.com

    2)url方式

      https://example.org

      https://example.org/api/                        API很简单

  3、版本

      URL,如:https://api.example.com/v1/

      请求头       跨域时,引发发送多次请求

  4、面向资源编程: 路径,视网络上任何东西都是资源,均使用名词表示(可复数)

      https://api.example.com/v1/zoos

      https://api.example.com/v1/animals

      https://api.example.com/v1/employees

  5、method

      GET      :从服务器取出资源(一项或多项)

      POST    :在服务器新建一个资源

      PUT      :在服务器更新资源(客户端提供改变后的完整资源)

      PATCH  :在服务器更新资源(客户端提供改变的属性)

      DELETE :从服务器删除资源

  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、状态码

‘‘‘1. 2XX请求成功‘‘‘
# 200 请求成功,一般用于GET与POST请求
# 201 Created - [POST/PUT/PATCH]:用户新建或修改数据成功。
# 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
# 204 NO CONTENT - [DELETE]:用户删除数据成功。
‘‘‘2. 3XX重定向‘‘‘
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 临时重定向
‘‘‘3. 4XX客户端错误‘‘‘
# 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误。
# 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
# 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
# 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录。
# 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
# 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
# 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
‘‘‘4. 5XX服务端错误‘‘‘
# 500 INTERNAL SERVER ERROR - [*]:服务器内部错误,无法完成请求
# 501 Not Implemented     服务器不支持请求的功能,无法完成请求

更多状态码参考:https://www.runoob.com/http/http-status-codes.html

  8、错误处理,状态码是4xx时,应返回错误信息,error当做key

      error: "Invalid API key" }

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

      GET /collection:返回资源对象的列表(数组)

      GET /collection/resource:返回单个资源对象

      POST /collection:返回新生成的资源对象

      PUT /collection/resource:返回完整的资源对象

      PATCH /collection/resource:返回完整的资源对象

      DELETE /collection/resource:返回一个空文档

  10、Hypermedia API

      RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

demo

1.3 基于django实现REST framework

urlpatterns = [
    url(r‘^users‘, Users.as_view()),
]

urls.py

from django.views import View
from django.http import JsonResponse

class Users(View):
    def get(self, request, *args, **kwargs):
        result = {
            ‘status‘: True,
            ‘data‘: ‘response data‘
        }
        return JsonResponse(result, status=200)

    def post(self, request, *args, **kwargs):
        result = {
            ‘status‘: True,
            ‘data‘: ‘response data‘
        }
        return JsonResponse(result, status=200) 

views.py

1.4 REST framework 基本使用

  1、安装 

      pip install djangorestframework

  2、djangorestframework 介绍

      1. djangorestframework 主要使用 APIView,其实APIView实质是对 View 进行继承加工了更多功能

      2. 请求来了 APIView首先执行 self.dispatch 方法,此方法对 request 进行了再次封装

原文地址:https://www.cnblogs.com/jiaxinzhu/p/12563335.html

时间: 2024-11-09 00:52:17

Django rest framework 基础的相关文章

Django Rest framework基础使用之Request/Response

1.Request restframework提供了一个Request对象(rest_framework.request.Request) Request对象继承了Django默认的HttpRequest对象,它最核心的功能就是请求数据都包含在request.data属性中,类似于Django的request.POST,但是request.data应用范围更广: 1)request.data:返回解析之后的请求体数据,类似于Django中标准的request.POST和request.FILES

Django Rest framework基础使用之 serializer

rest-framework文档地址:http://www.django-rest-framework.org/ 1.安装:pip install djangorestframework 说明:如果安装coreapi的时候,出现utf-8报错,可以将虚拟环境中的Lib---->site package--->pip--->compat---__init__.py中的第75行return s.decode("utf-8")改为"gbk",然后unin

Django REST framework基础:视图和路由

在原来modelserializers基础上进行了一次封装方便了使用 # author class AuthorModelSerializers(serializers.ModelSerializer): class Meta: model = models.Author fields = "__all__" from rest_framework import mixins from rest_framework import generics class AuthorView(mi

Django rest framework 使用自定义认证方式

Django rest framework 使用自定义认证方式 Django使用自定义认证方式 介绍了 "Django使用自定义认证方式",这一篇说说怎样在前一篇的基础上提供rest api. 修改settings.py中INSTALLED_APPS,添加 'login' app. 给login app增加serializers.py文件 #coding:utf-8 from django.contrib.auth.models import User from rest_framew

Django Rest framework序列化流程

目录 一 什么是序列化 二 Django REST framework配置流程之Serializer 三 Django REST framework配置流程之ModelSerializer 一 什么是序列化 序列化模型与序列化关系模型 序列化模型,顾名思义,即对 models 里的数据模型作序列化. 而序列化关系模型则是对 models 里数据模型中带有关系的如 ForeignKey, ManyToManyField 和 OneToOneField 字段作序列化. Django Rest Fra

Django REST framework+Vue 打造生鲜超市(一)

一.项目介绍 1.1.掌握的技术 Vue + Django Rest Framework 前后端分离技术 彻底玩转restful api 开发流程 Django Rest Framework 的功能实现和核心源码分析 Sentry 完成线上系统的错误日志的监控和告警 第三方登录和支付宝支付的集成 本地调试远程服务器代码的技巧 1.2.课程系统构成 vue前端项目 django rest framework 系统实现前台功能 xadmin后台管理系统 vue部分: API 接口 Vue 组件 与a

DRF (Django REST framework) 框架介绍

Web应用模式 在开发Web应用中,有两种应用模式: 前后端不分离 前后端分离 1 前后端不分离 在前后端不分离的应用模式中,前端页面看到的效果都是由后端控制,由后端渲染页面或重定向,也就是后端需要控制前端的展示,前端与后端的耦合度很高. 这种应用模式比较适合纯网页应用,但是当后端对接App时,App可能并不需要后端返回一个HTML网页,而仅仅是数据本身,所以后端原本返回网页的接口不再适用于前端App应用,为了对接App后端还需再开发一套接口. 2 前后端分离 在前后端分离的应用模式中,后端仅返

Django REST Framework剖析

一.简介 Django REST Framework(简称DRF),是一个用于构建Web API的强大且灵活的工具包. 先说说REST:REST是一种Web API设计标准,是目前比较成熟的一套互联网应用程序的API设计理论. Fielding将他对互联网软件的架构原则,定名为REST,即Representational State Transfer的缩写.我对这个词组的翻译是"表现层状态转化".如果一个架构符合REST原则,就称它为RESTful架构.所以简单来说,RESTful是一

Django rest framework源码分析(一) 认证

一.基础 最近正好有机会去写一些可视化的东西,就想着前后端分离,想使用django rest framework写一些,顺便复习一下django rest framework的知识,只是顺便哦,好吧.我承认我是故意的,因为我始终觉得,如果好的技术服务于企业,顺便的提高一下自己.大家都很开心不是不.再次强调一下,真的只是顺便. 安装吧 pip install djangorestframework 1.2.需要先了解的一些知识 理解下面两个知识点非常重要,django-rest-framework