您的位置:澳门新葡8455最新网站 > 编程教学 > RESTful API

RESTful API

发布时间:2019-12-02 18:02编辑:编程教学浏览(137)

    • REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移
    • REST从资源的角度类审视整个网络,它将分布在网络中某个节点的资源通过URL进行标识,客户端应用通过URL来获取资源的表征,获得这些表征致使这些应用转变状态
    • 所有的数据,不管是通过网络获取的还是操作数据库获得(增删改查)的数据,都是资源,将一切数据视为资源是REST区别与其他架构风格的最本质属性
    • 对于REST这种面向资源的架构风格,有人提出一种全新的结构理念,即:面向资源架构(ROA:Resource Oriented Architecture)
      • 对互联网上的任意东西都视为资源,他认为一个url就是一个资源 比如:

    1、什么是API?

    答:API就是接口,提供的url。接口有两个用途:

    • - 为别人提供服务
    • - 前后端分离,一个写vue,一个写后端,他们之间都是通过ajax请求

    网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。

    因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

    那么先来简单了解一下

    1、协议

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

    2、域名

    有两种方式

    方式一: 尽量将API部署在专用域名(会存在跨域问题)

    https://api.example.com
    

    方式二:如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。

    https://example.org/api/
    

    3、版本(Versioning)

    应该将API的版本号放入URL。

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

    另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

    4、路径(Endpoint)

    路径又称"终点"(endpoint),表示API的具体网址。

    在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。

    举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。

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

    5、HTTP动词

    对于资源的具体操作类型,由HTTP动词表示。

    常用的HTTP动词有下面五个(括号里是对应的SQL命令)。

    GET(SELECT):从服务器取出资源(一项或多项)。即获取数据
    POST(CREATE):在服务器新建一个资源。 即添加数据
    PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。即更新数据
    PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。即更新数据
    DELETE(DELETE):从服务器删除资源  。即删除数据
    

    还有两个不常用的HTTP动词。

    HEAD:获取资源的元数据。
    OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。
    

    下面是一些例子:

    GET /zoos:列出所有动物园
    POST /zoos:新建一个动物园
    GET /zoos/ID:获取某个指定动物园的信息
    PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)
    PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)
    DELETE /zoos/ID:删除某个动物园
    GET /zoos/ID/animals:列出某个指定动物园的所有动物
    DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物
    

    6、过滤信息(Filtering)

    如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。

    下面是一些常见的参数。

    ?limit=10:指定返回记录的数量
    ?offset=10:指定返回记录的开始位置。
    ?page=2&per_page=100:指定第几页,以及每页的记录数。
    ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。
    ?animal_type_id=1:指定筛选条件
    

    参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

    7、状态码(status codes)

    服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)。

    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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
    

    状态码的完全列表参见这里。

    8、错误处理(Error handling)

    如果状态码是4xx,就应该向用户返回出错信息。一般来说,返回的信息中将error作为键名,出错信息作为键值即可。

    {
        error: "Invalid API key"
    }
    

    9、返回结果

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

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

    10、Hypermedia API  超媒体API

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

    比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档。

    {"link": {
      "rel":   "collection https://www.example.com/zoos",  #表示这个API与当前网址的关系(collection关系,并给出该collection的网址)
      "href":  "https://api.example.com/zoos",  #API路径
      "title": "List of zoos",  #API的标题
      "type":  "application/vnd.yourformat+json"  #返回类型
    }}
    

    Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。

    {
      "current_user_url": "https://api.github.com/user",
      "authorizations_url": "https://api.github.com/authorizations",
      // ...
    }
    

    从上面可以看到,如果想获取当前用户的信息,应该去访问api.github.com/user,然后就得到了下面结果。

    {
      "message": "Requires authentication",
      "documentation_url": "https://developer.github.com/v3"
    }
    

    方式一:FBV模式:

    澳门新葡萄京娱乐场 1澳门新葡萄京娱乐场 2

    from django.contrib import admin
    
    from django.conf.urls import url, include
    from app01 import views
    from app02 import views
    
    urlpatterns = [
        url('admin/', admin.site.urls),
        # path('hosts/',views.HostView.as_view()),
        url('app02/', include('app02.urls'))
    ]
    

    全局url

    澳门新葡萄京娱乐场 3澳门新葡萄京娱乐场 4

    from app02 import views
    from django.conf.urls import url
    urlpatterns = [
        url('^users/', views.users),
        url('^user/(d+)', views.user),
    
    
    ]
    

    app02/url

    澳门新葡萄京娱乐场 5澳门新葡萄京娱乐场 6

    from django.shortcuts import render,HttpResponse
    
    # Create your views here.
    import json
    
    def users(request):
        response = {'code':1000,'data':None}  #code用来表示状态,比如1000代表成功,1001代表
        response['data'] = [
            {'name':'haiyan','age':22},
            {'name':'haidong','age':10},
            {'name':'haixiyu','age':11},
        ]
        return HttpResponse(json.dumps(response))  #返回多条数据
    
    def user(request,pk):
        if request.method =='GET':
            return HttpResponse(json.dumps({'name':'haiyan','age':11}))  #返回一条数据
        elif request.method =='POST':
            return HttpResponse(json.dumps({'code':1111}))  #返回一条数据
        elif request.method =='PUT':
            pass
        elif request.method =='DELETE':
            pass
    

    views

     

    方式二:CBV模式

    澳门新葡萄京娱乐场 7澳门新葡萄京娱乐场 8

     from app02 import views
     from django.conf.urls import url
     urlpatterns = [
         url('^users/', views.UsersView.as_view()),
         url('^user/', views.UserView.as_view()),
     ]
    

    app02/urls

    澳门新葡萄京娱乐场 9澳门新葡萄京娱乐场 10

    from django.views import View
    class UsersView(View):
        def get(self,request):
            response = {'code':1000,'data':None}
            response['data'] = [
                {'name': 'haiyan', 'age': 22},
                {'name': 'haidong', 'age': 10},
                {'name': 'haixiyu', 'age': 11},
            ]
            return HttpResponse(json.dumps(response),stutas=200)
    
    class UserView(View):
        def get(self,request,pk):
            return HttpResponse(json.dumps({'name':'haiyan','age':11}))  #返回一条数据
        def post(self,request,pk):
            return HttpResponse(json.dumps({'code':1111}))  #返回一条数据
        def put(self,request,pk):
            pass
        def delete(self,request,pk):
            pass
    

    views

    基于django实现的API许多功能都需要我们自己开发,这时候djangorestframework就给我们提供了方便,直接基于它来返回数据,总之原理都是一样的,就是给一个接口也就是url,让前端的人去请求这个url去获取数据,在页面上显示出来。这样也就达到了前后端分离的效果。下面我们来看看基于Django Rest Framework框架实现

    1、自定义认证规则 

    详见链接

    class MyAuthtication(BasicAuthentication):
        def authenticate(self, request):
            token = request.query_params.get('token')  #注意是没有GET的,用query_params表示
            if token == 'zxxzzxzc':
                return ('uuuuuu','afsdsgdf') #返回user,auth
            raise APIException('认证错误')
    
    class UserView(APIView):
        authentication_classes = [MyAuthtication,]
        def get(self,request,*args,**kwargs):
            print(request.user)
            print(request.auth)
            return Response('用户列表')
    

    2、应用:

    主要是做Token验证  url中as_view里面调用了dispatch方法。

    可以有两种方式

    局部使用

    澳门新葡萄京娱乐场 11澳门新葡萄京娱乐场 12

    from app01 import views
    from django.conf.urls import url
    urlpatterns = [
        # django rest framework
        url('^hosts/', views.HostView.as_view()),
        url(r'^auth/', views.AuthView.as_view()),
    ]
    

    urls.py

    澳门新葡萄京娱乐场 13澳门新葡萄京娱乐场 14

    from django.shortcuts import render,HttpResponse
    # Create your views here.
    from rest_framework.views import  APIView
    from rest_framework.views import Request
    from rest_framework.authentication import SessionAuthentication
    from rest_framework.authentication import BaseAuthentication, BasicAuthentication
    from rest_framework.parsers import JSONParser
    from rest_framework.negotiation import  DefaultContentNegotiation
    from rest_framework.exceptions import APIException
    from app01 import models
    from rest_framework.response import Response  #友好的显示返回结果
    
    
    
    class AuthView(APIView):
        #auth登录页面不需要验证,可设置
        authentication_classes = []  #登录页面不需要认证
        def get(self,request):
            '''
            接收用户名和密码
            :param request:
            :return:
            '''
            ret = {'code':1000,'msg':None}
            user = request.query_params.get('username')
    
            pwd = request.query_params.get('password')
            print(user,pwd)
            obj = models.UserInfo.objects.filter(username=user,password=pwd).first()
            print(obj)
            if not obj :
                ret['code'] = 1001
                ret['msg'] = '用户名或者密码错误'
                return Response(ret)
            #创建随机字符串
            import time
            import hashlib
            ctime = time.time()
            key = '%s|%s'%(user,ctime)
            m = hashlib.md5()
            m.update(key.encode('utf-8'))
            token = m.hexdigest()
    
            #保存数据
            obj.token = token
            obj.save()
    
            ret['token'] = token
            return Response(ret)
    
    class HostView(APIView):
        def dispatch(self, request, *args, **kwargs):
            return super().dispatch(request, *args, **kwargs)
    
        # authentication_classes = [MyAuthtication]
    
        def get(self,request,*args,**kwargs):
            print(request.user,'dddddddddddffffff')
            print(request.auth,'dddddddddd')
            #原来的request,django.core.handlers.wsgi.WSGIRequest
            #现在的request ,rest_framework.request.Request
            # print(request)
            authentication_classes = [SessionAuthentication,BaseAuthentication]
            # print(self.authentication_classes)  # [<class 'rest_framework.authentication.SessionAuthentication'>,
                                                #  <class 'rest_framework.authentication.BasicAuthentication'>]
            return HttpResponse('GET请求的响应内容')
    
        def post(self,request,*args,**kwargs):
            pass
            # try:
            #     try :
            #         current_page = request.POST.get("page")
            #
            #         current_page = int(current_page)
            #         int("asd")
            #     except ValueError as e:
            #         print(e)
            #         raise #如果有raise说明自己处理不了了,就交给下面的一个去捕捉了
            # except Exception as e:
            #     print("OK")
    
    
            return  HttpResponse('post请求的响应内容')
    
        def put(self, request, *args, **kwargs):
            return HttpResponse('put请求的响应内容')
    

    Views.py

    澳门新葡萄京娱乐场,全局使用

    澳门新葡萄京娱乐场 15澳门新葡萄京娱乐场 16

    #注册认证类
    REST_FRAMEWORK = {
        'UNAUTHENTICATED_USER': None,
        'UNAUTHENTICATED_TOKEN': None,  #将匿名用户设置为None
        "DEFAULT_AUTHENTICATION_CLASSES": [
            "app01.utils.MyAuthentication",
        ],
    }
    

    settings

    澳门新葡萄京娱乐场 17澳门新葡萄京娱乐场 18

    from  rest_framework.authentication import BaseAuthentication
    from rest_framework.exceptions import APIException
    from app02 import models
    
    
    class MyAuthentication(BaseAuthentication):
        def authenticate(self, request):
            token=request.query_params.get('token')
            print(token)
            obj=models.UserInfo.objects.filter(token=token).first()
            print(obj)
            if obj:
                return (obj.username,obj)
            raise  APIException('没有通过验证')
    

    全局验证

    注:rest_framewor是一个app需要settings里面设置。

    澳门新葡萄京娱乐场 19

    遇到这个错误就是因为没有在settins中注册rest_framework.

    如果不想用默认的模板显示,只想显示json数据,则

    from rest_framework.renderers import JSONRenderer
    
    class HostView(APIView):
        renderer_classes = [JSONRenderer,]
    
        def get(self,request,*args,**kwargs):
            self.dispatch
            print(request.user)
            print(request.auth)
            return Response('主机列表')
    

     

    本文由澳门新葡8455最新网站发布于编程教学,转载请注明出处:RESTful API

    关键词:

上一篇:没有了

下一篇:ord() expected string of length 1, but int found