RESTful API

发布时间：2020-12-15 17:20:24 所属栏目：大数据来源：网络整理

导读：h1 id="lable1" class="title"一、什么是RESTful REST与技术无关，代表的是一种软件架构风格，REST是Representational State Transfer的简称，中文翻译为表征状态转移 REST从资源的角度类审视整个网络，它将分布在网络中某个节点的资源通过URL进行标识，客

<h1 id="lable1" class="title">一、什么是RESTful

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

1、什么是API？

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

- 为别人提供服务

- 前后端分离，一个写vue，一个写后端，他们之间都是通过ajax请求

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

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

那么先来简单了解一下

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

有两种方式

方式一：尽量将API部署在专用域名（会存在跨域问题）

https://api.example.com

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

https://example.org/api/

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

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

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

路径又称"终点"（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

对于资源的具体操作类型，由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：删除某个指定动物园的指定动物

如果记录数量很多，服务器不可能都将它们返回给用户。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 的含义是相同的。

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见。

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

{ error: "Invalid API key" }

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

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

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

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

{: , : , : , : }}

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

: : //

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

: :

django.contrib 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'))
]

app02 django.conf.urls =

django.shortcuts # 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

<h2 class="secondtitle">方式二：CBV模式

  app02  django.conf.urls =

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

1、自定义认证规则

详见

= request.query_params.get() token == (,) APIException(class UserView(APIView):
authentication_classes = [MyAuthtication,]
def get(self,*args,**kwargs):
print(request.user)
print(request.auth)
return Response('用户列表')

2、应用：

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

可以有两种方式

局部使用

app01 django.conf.urls = url(

django.shortcuts rest_framework.views rest_framework.views rest_framework.authentication rest_framework.authentication rest_framework.parsers rest_framework.negotiation rest_framework.exceptions app01 rest_framework.response 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 </span>= request.query_params.get(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;password</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(user,pwd)
    obj </span>= models.UserInfo.objects.filter(username=user,password=<span style="color: #000000;"&gt;pwd).first()
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(obj)
    </span><span style="color: #0000ff;"&gt;if</span> <span style="color: #0000ff;"&gt;not</span><span style="color: #000000;"&gt; obj :
        ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;code</span><span style="color: #800000;"&gt;'</span>] = 1001<span style="color: #000000;"&gt;
        ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;msg</span><span style="color: #800000;"&gt;'</span>] = <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;用户名或者密码错误</span><span style="color: #800000;"&gt;'</span>
        <span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; Response(ret)
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;创建随机字符串</span>
    <span style="color: #0000ff;"&gt;import</span><span style="color: #000000;"&gt; time
    </span><span style="color: #0000ff;"&gt;import</span><span style="color: #000000;"&gt; hashlib
    ctime </span>=<span style="color: #000000;"&gt; time.time()
    key </span>= <span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;%s|%s</span><span style="color: #800000;"&gt;'</span>%<span style="color: #000000;"&gt;(user,ctime)
    m </span>=<span style="color: #000000;"&gt; hashlib.md5()
    m.update(key.encode(</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;utf-8</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;))
    token </span>=<span style="color: #000000;"&gt; m.hexdigest()

    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;保存数据</span>
    obj.token =<span style="color: #000000;"&gt; token
    obj.save()

    ret[</span><span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;token</span><span style="color: #800000;"&gt;'</span>] =<span style="color: #000000;"&gt; token
    </span><span style="color: #0000ff;"&gt;return</span><span style="color: #000000;"&gt; Response(ret)

class HostView(APIView):
def dispatch(self,kwargs):
return super().dispatch(request,kwargs)

</span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; authentication_classes = [MyAuthtication]</span>

<span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;print</span>(request.user,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;dddddddddddffffff</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)
    </span><span style="color: #0000ff;"&gt;print</span>(request.auth,<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;dddddddddd</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;原来的request，django.core.handlers.wsgi.WSGIRequest</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;现在的request,rest_framework.request.Request</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; print(request)</span>
    authentication_classes =<span style="color: #000000;"&gt; [SessionAuthentication,BaseAuthentication]
    </span><span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; print(self.authentication_classes)  # [<class 'rest_framework.authentication.SessionAuthentication'>,</span>
                                        <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;  <class 'rest_framework.authentication.BasicAuthentication'>]</span>
    <span style="color: #0000ff;"&gt;return</span> HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;GET请求的响应内容</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)

</span><span style="color: #0000ff;"&gt;def</span> post(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;pass</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt; try:</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;     try :</span>
    <span style="color: #008000;"&gt;#</span><span style="color: #008000;"&gt;         current_page = request.POST.get("page")</span>
    <span style="color: #008000;"&gt;#

# current_page = int(current_page)
# int("asd")
# except ValueError as e:
# print(e)
# raise #如果有raise说明自己处理不了了，就交给下面的一个去捕捉了
# except Exception as e:
# print("OK")

    <span style="color: #0000ff;"&gt;return</span>  HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;post请求的响应内容</span><span style="color: #800000;"&gt;'</span><span style="color: #000000;"&gt;)

</span><span style="color: #0000ff;"&gt;def</span> put(self,**<span style="color: #000000;"&gt;kwargs):
    </span><span style="color: #0000ff;"&gt;return</span> HttpResponse(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;put请求的响应内容</span><span style="color: #800000;"&gt;'</span>)</pre>

全局使用

REST_FRAMEWORK =: None,

rest_framework.authentication rest_framework.exceptions app02 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('没有通过验证')

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

rest_framework.renderers class HostView(APIView):
renderer_classes = [JSONRenderer,]

</span><span style="color: #0000ff;"&gt;def</span> get(self,**<span style="color: #000000;"&gt;kwargs):
    self.dispatch
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(request.user)
    </span><span style="color: #0000ff;"&gt;print</span><span style="color: #000000;"&gt;(request.auth)
    </span><span style="color: #0000ff;"&gt;return</span> Response(<span style="color: #800000;"&gt;'</span><span style="color: #800000;"&gt;主机列表</span><span style="color: #800000;"&gt;'</span>)</pre>

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!