统筹指南

  • REST与技能毫无干系,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,汉译为“特点状态转移
  • REST从能源的角度类审视整个网络,它将遍布在网络中某些节点的能源通过U福特ExplorerL举行标识,客户端应用通过URAV4L来获得能源的性子,获得这几个特色致使这么些使用转变状态
  • 具备的数目,不管是经过互连网获取的依然操作数据库获得(增加和删除改查)的数码,都以财富,将全体数据便是能源是REST差别与别的架构风格的最本质属性
  • 对此REST那种面向财富的框架结构风格,有人提议一种崭新的结构理念,即:面向财富架构(ROA:Resource
    Oriented Architecture)

    • 对网络上的任意东西都说是能源,他觉得3个url正是3个能源比如:

RESTful API,restfulapi

  • REST与技能无关,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,汉语翻译为“特征状态转移
  • REST从财富的角度类审视整个互联网,它将遍布在网络中有个别节点的财富通过UEscortL实行标识,客户端应用通过U昂科雷L来收获能源的性状,获得这一个特点致使那个使用转变状态
  • 不无的多少,不管是经过互联网获取的可能操作数据库得到(增加和删除改查)的数据,都以能源,将全方位数据就是能源是REST差距与任何架构风格的最本质属性
  • 对于REST那种面向能源的架构风格,有人提议一种崭新的结构理念,即:面向财富架构(ROA:Resource
    Oriented Architecture)

    • 对互连网上的妄动东西都说是能源,他认为二个url正是二个能源比如:

1、什么是API?

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

  • – 为外人提供劳动
  • – 前后端分离,二个写vue,三个写后端,他们中间都以透过ajax请求

互联网应用程序,分为前端和后端七个部分。当前的发展趋势,正是前者设备见惯不惊(手提式有线电电话机、平板、桌面电脑、别的专用设备……)。

于是,必须有一种统一的建制,方便分歧的前端设备与后端举行通讯。那致使API构架的风靡,甚至现身”API
First”的宏图思想。RESTful
API是时下相比早熟的一套互连网应用程序的API设计理论。

统筹指南。那么先来归纳精通一下

100、RESTful API,100restfulapi

本篇导航:

  • RESTful
  • RESTful API设计
  • 基于django实现
  • 依据Django Rest Framework框架完毕

 

一、RESTful

REST与技能无关,代表的是一种软件架构风格,REST是Representational State
Transfer的简称,普通话翻译为“表征状态转移”

REST从财富的角度类审视整个互联网,它将遍布在互联网中某些节点的能源通过UPAJEROL进行标识,客户端应用通过UWranglerL来赢得财富的特色,得到那个特点致使那几个使用转变状态

REST与技术毫不相关,代表的是一种软件架构风格,REST是Representational State
Transfer的简称,汉语翻译为“表征状态转移”

不无的数据,然而是透过互联网获得的要么操作(增加和删除改查)的数目,都以财富,将全体数据就是财富是REST分歧与任何架构风格的最本质属性

对于REST那种面向能源的架构风格,有人提议一种崭新的组织理念,即:面向能源架构(ROA:Resource
Oriented Architecture)


 

二、RESTful API设计

网络应用程序,分为前端和后端八个部分。当前的发展趋势,便是前者设备见怪不怪(手提式有线电话机、平板、桌面电脑、别的专用设备……)。

从而,必须有一种统一的编写制定,方便不一致的前端设备与后端进行通信。那造成API构架的风靡,甚至出现”API
First”的筹划思想。RESTful
API是近来可比早熟的一套互连网应用程序的API设计理论。

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

– 为外人提供服务

– 前后端分离,三个写vue,三个写后端,他们中间都以由此ajax请求

1、协议

API与用户的通讯协议,总是接纳HTTPs协议。

2、域名

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

3、版本(**Versioning**)

有道是将API的版本号放入U途睿欧L。

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

另一种做法是,将版本号放在HTTP头音信中,但比不上放入ULANDL方便和直观。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动词(method)

对于财富的具体操作类型,由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:删除某个指定动物园的指定动物

⑥ 、过滤音信(Filtering)

若果记录数据很多,服务器不容许都将它们重回给用户。API应该提供参数,过滤再次来到结果。

下边是一些广大的参数。

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

参数的安排允许存在冗余,即允许API路径和UOdysseyL参数偶尔有重新。比如,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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。

状态码的通通列表见:

⑧ 、错误处理(Error handling)

设若状态码是4xx,就相应向用户再次回到出错音信。一般的话,重临的新闻司令员error作为键名,出错信息作为键值即可。

{
    error: "Invalid API key"
}

⑨ 、重临结果

针对不一样操作,服务器向用户重返的结果应当符合以下标准。

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

10、Hypermedia API

RESTful
API最佳达成Hypermedia,即再次来到结果中提供链接,连向其余API方法,使得用户不查文书档案,也知晓下一步应该做什么样。

诸如,当用户向api.example.com的根目录发出请求,会收获这么一个文书档案。

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

11、其他

1)API的地方验证应该利用OAuth 2.0框架。

2)服务器重回的数额格式,应该尽量使用JSON,防止接纳XML。


 

三、基于django实现

1、FBV模式

全局url

from django.contrib import admin

from django.conf.urls import url, include

urlpatterns = [
    url('admin/', admin.site.urls),
    url('api/', include('api.urls'))
]

 api.urls

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

 views

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

2、CBV模式

 api.urls

from api import views
from django.conf.urls import url

urlpatterns = [
    url('^users/', views.UsersView.as_view()),
    url('^user/', views.UserView.as_view()),
]

views

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

依照django实现的API许多职能都亟需大家友好付出,那时候Django Rest
Framework框架就给大家提供了有利。


 

四 、基于Django Rest Framework框架完结

url.py

from django.conf.urls import url, include
from web.views.s1_api import TestView

urlpatterns = [
    url(r'^test/', TestView.as_view()),
]

views.py

from rest_framework.views import APIView
from rest_framework.response import Response


class TestView(APIView):
    def dispatch(self, request, *args, **kwargs):
        """
        请求到来之后,都要执行dispatch方法,dispatch方法根据请求方式不同触发 get/post/put等方法

        注意:APIView中的dispatch方法有好多好多的功能
        """
        return super().dispatch(request, *args, **kwargs)

    def get(self, request, *args, **kwargs):
        return Response('GET请求,响应内容')

    def post(self, request, *args, **kwargs):
        return Response('POST请求,响应内容')

    def put(self, request, *args, **kwargs):
        return Response('PUT请求,响应内容')

上述是rest
framework框架基本流程,首要的出力是在APIView的dispatch中触发。

第壹没有Django
rest_Framework框架用django也是足以做出来的,只可是它为大家提供部分API常用的效能,比如:(认证,权限,限流,有了那几个大家只须要写个类已布局,它就能当都市图用,还是可以够全局配置,假若本身写还得写中间件,写装饰器来落到实处,通过Django
rest_Framework框架,他早已把规则写好,只须求写类,只需兑现格局,再次回到值就能够)完成了一片段机能。

 

API,100restfulapi 本篇导航:
RESTful RESTful API设计 基于django达成 基于Django Rest Framework框架完结壹 、RESTful REST与技能非亲非故,代表的是…

Django RESTful API 设计指南,djangorestful

互连网应用程序,分为前端和后端八个部分。当前的发展趋势,就是前者设备家常便饭(手提式有线电话机、平板、桌面电脑、其余专用设备……)。

故此,必须有一种统一的编写制定,方便区别的前端设备与后端进行通讯。那致使API构架的流行,甚至出现”API
First”的安顿思想。RESTful
API是方今可比早熟的一套互连网应用程序的API设计理论。笔者原先写过一篇《通晓RESTful架构》,商量怎么样驾驭这些定义。

后天,笔者将介绍RESTful
API的统一筹划细节,探究怎么样统一筹划一套合理、好用的API。小编的要害参考资料是那篇《Principles
of good RESTful API Design》。

  1. 协议

API与用户的通讯协议,总是利用HTTPs协议。

  1. 域名

相应尽量将API布署在专用域名之下。

一经鲜明API相当粗略,不会有特别扩大,能够设想放在主域名下。

  1. 版本(Versioning)

应当将API的版本号放入U普拉多L。

另一种做法是,将版本号放在HTTP头新闻中,但不及放入URubiconL方便和直观。

  1. 路径(Endpoint)

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

在RESTful架构中,每种网址代表一种财富(resource),所以网址中无法有动词,只好盛名词,而且所用的名词往往与数据库的表格名对应。一般的话,数据库中的表都以同种记录的”集合”(collection),所以API中的名词也理应利用复数。

比喻来说,有叁个API提供动物园(zoo)的新闻,还包蕴各个动物和雇员的音信,则它的不二法门应该设计成下边那样。

  1. 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:删除有个别钦点动物园的钦赐动物

  1. 过滤新闻(Filtering)

万一记录数据很多,服务器不恐怕都将它们重返给用户。API应该提供参数,过滤重返结果。下边是部分宽广的参数。

?limit=10:内定重临记录的多少
?offset=10:钦点重返记录的始发地方。
?sortby=name&order=asc:钦命再次来到结果依据哪个属性排序,以及排序依次。
?animal_type_id=1:钦定筛选标准
参数的安顿允许存在冗余,即允许API路径和UENVISIONL参数偶尔有重复。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意思是同样的。

  1. 状态码(Status Codes)

服务器向用户重返的状态码和提醒新闻,常见的有以下部分(方括号中是该状态码对应的HTTP动词)。

200 OK –
[GET]:服务器成功再次来到用户请求的多寡,该操作是幂等的(Idempotent)。
201 CREATED – [POST/PUT/PATCH]:用户新建或涂改数据成功。
204 NO CONTENT – [DELETE]:用户删除数据成功。
400 INVALID REQUEST –
[POST/PUT/PATCH]:用户爆发的央浼有不当,服务器并未进展新建或涂改数据的操作,该操作是幂等的。。
404 NOT FOUND –
[*]:用户产生的乞请针对的是不设有的笔录,服务器并未开始展览操作,该操作是幂等的。
500 INTERNAL SERVER ERROR –
[*]:服务器产生错误,用户将不可能断定发生的乞求是或不是成功。
状态码的完全列表参见那里。

  1. 错误处理(Error handling)

一经状态码是4xx,就应有向用户重临出错新闻。一般的话,重返的音信中校error作为键名,出错音信作为键值即可。

{
error: “Invalid API key”
}

  1. 回来结果

本着差别操作,服务器向用户再次回到的结果应该符合以下标准。

GET /collection:再次回到财富对象的列表(数组)
GET /collection/resource:再次来到单个财富对象
POST /collection:再次回到新生成的能源对象
PUT /collection/resource:再次回到完整的能源对象
PATCH /collection/resource:重返完整的财富对象
DELETE /collection/resource:重回一个空文书档案

  1. Hypermedia API

RESTful
API最佳成功Hypermedia,即重临结果中提供链接,连向别的API方法,使得用户不查文档,也掌握下一步应该做怎样。比如,当用户向api.example.com的根目录发出请求,会获得这么贰个文书档案。

{“link”: {
“rel”: “collection “,
“href”: “”,
“title”: “List of zoos”,
“type”: “application/vnd.yourformat+json”
}}
下面代码表示,文书档案中有1个link属性,用户读取这一个性子就了然下一步该调用什么API了。rel表示这几个API与眼下网址的关联(collection关系,并付出该collection的网址),href表示API的门路,title表示API的标题,type表示回去类型。

Hypermedia
API的规划被叫做HATEOAS。Github的API正是那种规划,访问api.github.com会取得3个怀有可用API的网址列表。

{
“current_user_url”: “”,
亚洲必赢官网,”authorizations_url”: “”,
// …
}
从上边能够阅览,假若想得到当前用户的新闻,应该去拜谒api.github.com/user,然后就获得了下边结果。

{
“message”: “Requires authentication”,
“documentation_url”: “”
}
地方代码表示,服务器交由了提醒音讯,以及文书档案的网址。

  1. 其他

(1)API的地点认证应该利用OAuth 2.0框架。

(2)服务器再次来到的多寡格式,应该尽量利用JSON,防止使用XML

转自

RESTful API 设计指南,djangorestful
网络应用程序,分为前端和后端五个部分。当前的发展趋势,正是前者设备无独有偶(手机、平板、桌…

1、什么是API?

1、协议

API与用户的通讯协议,总是选取HTTPs协议。

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

2、域名

有三种格局

办法一: 尽量将API布署在专用域名(会存在跨域难点)

https://api.example.com

艺术二:若是鲜明API非常粗大略,不会有特别扩展,能够设想放在主域名下。

https://example.org/api/
  • – 为人家提供劳动
  • – 前后端分离,八个写vue,三个写后端,他们中间都以通过ajax请求

3、版本(Versioning)

相应将API的版本号放入U大切诺基L。

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

另一种做法是,将版本号放在HTTP头信息中,但不比放入U奥迪Q5L方便和直观。Github接纳那种做法。

互联网应用程序,分为前端和后端八个部分。当前的发展趋势,就是前者设备司空见惯(手提式有线电话机、平板、桌面电脑、别的专用设备……)。

4、路径(Endpoint)

路线又称”终点”(endpoint),表示API的切切实实网址。

在RESTful架构中,每一个网址代表一种财富(resource),所以网址中不可能有动词,只好有名词,而且所用的名词往往与数据库的表格名对应。一般的话,数据库中的表都以同种记录的”集合”(collection),所以API中的名词也应有利用复数。

比喻来说,有3个API提供动物园(zoo)的新闻,还包含种种动物和雇员的消息,则它的门路应该设计成上边那样。

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

所以,必须有一种统一的体制,方便分裂的前端设备与后端进行通讯。那造成API构架的盛行,甚至出现”API
First”的规划思想。RESTful
API是当前可比成熟的一套网络应用程序的API设计理论。

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:删除某个指定动物园的指定动物

那正是说先来大概询问一下

陆 、过滤音讯(Filtering)

要是记录数据过多,服务器非常小概都将它们再次回到给用户。API应该提供参数,过滤再次回到结果。

上面是有的广大的参数。

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

参数的安顿允许存在冗余,即允许API路径和U普拉多L参数偶尔有重新。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意思是如出一辙的。

1、协议

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

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

状态码的一点一滴列表参见那里。

2、域名

有三种办法

艺术一: 尽量将API安顿在专用域名(会设有跨域难点)

https://api.example.com

主意二:假设明确API很简单,不会有进一步扩张,能够设想放在主域名下。

https://example.org/api/

⑧ 、错误处理(Error handling)

借使状态码是4xx,就应有向用户重回出错音信。一般的话,重临的新闻大校error作为键名,出错音讯作为键值即可。

{
    error: "Invalid API key"
}

3、版本(Versioning)

应当将API的版本号放入U景逸SUVL。

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

另一种做法是,将版本号放在HTTP头信息中,但不比放入U昂CoraL方便和直观。Github选用这种做法。

9、重临结果

本着差别操作,服务器向用户重返的结果应该符合以下标准

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

4、路径(Endpoint)

途径又称”终点”(endpoint),表示API的求实网址。

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

比方来说,有1个API提供动物园(zoo)的音信,还包涵各个动物和雇员的音信,则它的门径应该设计成上面那样。

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

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会取得3个拥有可用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"
}

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:删除某个指定动物园的指定动物

方式一:FBV模式:

 

六 、过滤消息(Filtering)

假定记录数据过多,服务器不容许都将它们再次回到给用户。API应该提供参数,过滤重临结果。

上边是局地周边的参数。

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

参数的宏图允许存在冗余,即允许API路径和U途观L参数偶尔有双重。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的意思是一律的。

方式二:CBV模式

依照django达成的API许多意义都急需大家友好开发,那时候djangorestframework就给我们提供了有利于,直接基于它来回到数据,不问可见原理都以相同的,正是给1个接口也等于url,让前者的人去央浼那几个url去获取数据,在页面上出示出来。那样也就直达了前后端分离的效益。上边大家来探望基于Django
Rest Framework框架实现

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

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

① 、自定义表明规则 

详见链接

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('用户列表')

⑧ 、错误处理(Error handling)

万一状态码是4xx,就应该向用户重临出错音讯。一般的话,再次回到的新闻中校error作为键名,出错音讯作为键值即可。

{
    error: "Invalid API key"
}

2、应用:

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

可以有两种方法

玖 、重返结果

针对分化操作,服务器向用户重回的结果应当符合以下标准

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"
}

大局使用

注:rest_framewor是叁个app须要settings里面设置。

API,restfulapi 壹 、 什么是RESTful
REST与技术非亲非故,代表的是一种软件架构风格,REST是Representational State
Transfer的简称,汉语翻译为 表征…

方式一: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框架达成

① 、自定义表明规则 

详见链接

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('主机列表')

 

网站地图xml地图