zoukankan      html  css  js  c++  java
  • RESTful-rest_framework应用第一篇

    一:了解RESTful

    主要是做前后端分离用的,RESTful只做后台数据和接口,供外面去调用。

    REST是Representational State Transfer的简称,中文翻译为“表征状态转移”。

    REST与技术无关,代表的是一种面向资源的架构风格,即面向资源架构(ROA:Resource Oriented Architecture)。

    二:RESTful API

    API与用户的通信协议(即接口),用HTTPs协议

    域名 

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

    版本(方便不同版本间的切换,v1就代表一个版本)

    • URL,如:https://api.example.com/v1/
    • 请求头                                                  跨域时,引发发送多次请求

    路径,视网络上任何东西都是资源,均使用名词表示(可复数),而不再用get/post区分

    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees

    method

    • GET      :从服务器取出资源(一项或多项)
    • POST    :在服务器新建一个资源
    • PUT      :在服务器更新资源(客户端提供改变后的完整资源)
    • PATCH  :在服务器更新资源(客户端提供改变的属性)
    • DELETE :从服务器删除资源

    过滤,通过在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:指定筛选条件

    状态码:

    200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
    201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
    202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
    204 NO CONTENT - [DELETE]:用户删除数据成功。
    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] 当创建一个对象时,发生一个验证错误。
    500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    
    更多看这里:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
    

    错误处理,应返回错误信息,error当做key

    1 {
    2     error: "Invalid API key"
    3 }

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

    1 GET /collection:返回资源对象的列表(数组)
    2 GET /collection/resource:返回单个资源对象
    3 POST /collection:返回新生成的资源对象
    4 PUT /collection/resource:返回完整的资源对象
    5 PATCH /collection/resource:返回完整的资源对象
    6 DELETE /collection/resource:返回一个空文档

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

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

    摘自:http://www.ruanyifeng.com/blog/2014/05/restful_api.html

    三:基于Django实现

    安装模块:djangorestframework

    方法1:cmd下安装  pip3 install djangorestframework

    方法2:pycharm下安装

    路由系统:

    from django.conf.urls import url
    from django.contrib import admin
    from api import views
    urlpatterns = [
        url(r'^admin/', admin.site.urls),
        url(r'^book/', views.Book.as_view()),
    ]

    settings配置:

    INSTALLED_APPS = [
        'django.contrib.admin',
        'django.contrib.auth',
        'django.contrib.contenttypes',
        'django.contrib.sessions',
        'django.contrib.messages',
        'django.contrib.staticfiles',
        'api.apps.ApiConfig',
        'rest_framework'     #注意这一项
    ]

    models配置:

    from django.db import models
    
    # Create your models here.
    
    from django.db import models
    
    class Book(models.Model):
        title=models.CharField(max_length=32)
        price=models.IntegerField()
        pub_date=models.DateField()
        publish=models.ForeignKey("Publish")
        authors=models.ManyToManyField("Author")
        def __str__(self):
            return self.title
    
    class Publish(models.Model):
        name=models.CharField(max_length=32)
        email=models.EmailField()
        # def __str__(self):
        #     return self.name
    
    class Author(models.Model):
        name=models.CharField(max_length=32)
        age=models.IntegerField()
        def __str__(self):
            return self.name

    views视图函数:

    from django.shortcuts import render,HttpResponse,redirect
    import json
    from api import models
    # Create your views here.
    
    from api.models import Book
    
    from rest_framework.views import  APIView
    from rest_framework import serializers
    from rest_framework.response import Response
    
    
    #RESful提供的一个序列化组件BookSerializer,可以控制传入的参数
    class BookSerializer(serializers.Serializer):
        #前面的字段可以重命名,为了对应到指定的数据库字段,需要指定source
        # xx = serializers.CharField(source='title')
        title=serializers.CharField()
        price=serializers.CharField()
        pub_date=serializers.DateField()
        #publish是个object对象,所以可以.name查看里面的内容
        publish=serializers.CharField(source="publish.name")
    
    
    class Book(APIView):
        def get(self,request):                 #request是已经处理好的request
    
            ret = models.Book.objects.all()
            print(ret,type(ret)) #ret是QuerySet对象  <class 'django.db.models.query.QuerySet'>
    
            # 实例化上面的BookSerializer拿到一个book_ser对象
            # BookSerializer参数(ret:queryset对象,many=True代表序列化多条,many=False 代表序列化一条)
            book_ser=BookSerializer(ret,many=True)
            # print(book_ser,type(book_ser)) #BookSerializer
    
            return Response(book_ser.data)
    
        def post(self,request):
            print(request.data)
            print(request.POST)
            return HttpResponse('ok')
  • 相关阅读:
    如何下载文件
    线程方法wait()和notify()的使用
    多线程的同步问题
    线程
    线程上下文类加载器(Context ClassLoader)
    自定义ClassLoader的使用
    类加载器及其双亲委托机制
    类加载机制导致静态变量出错问题
    JAVA JVM助记符
    JVM调试说明
  • 原文地址:https://www.cnblogs.com/yangzhizong/p/9774929.html
Copyright © 2011-2022 走看看