当前位置:3016.com-金沙城中心官网 > 编程 > RESTful API

RESTful API

文章作者:编程 上传时间:2019-10-11
  • REST与技术非亲非故,代表的是一种软件架构风格,REST是Representational State Transfer的简称,普通话翻译为“天性状态转移
  • REST从财富的角度类审视整个网络,它将布满在互连网中某些节点的能源通过U大切诺基L实行标记,顾客端应用通过U奥德赛L来获得财富的特点,获得这几个特征致使这几个应用调换状态
  • 全体的数量,不管是透过网络得到的要么操作数据库得到(增加和删除改查)的数目,都以财富,将一切数据正是财富是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的版本号归入USportageL。

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

另一种做法是,将版本号放在HTTP头音信中,但比不上归入UPRADOL方便和直观。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路线和UENCOREL参数不时有重新。比如,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('主机列表')

 

本文由3016.com-金沙城中心官网发布于编程,转载请注明出处:RESTful API

关键词: