【美高梅开户网址】规划指南

  • REST与技能非亲非故,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,汉译为“特征状态转移
  • REST从能源的角度类审视整个网络,它将遍布在网络中某些节点的能源通过U奥迪Q7L举办标识,客户端应用通过UXC60L来获取能源的表征,获得那几个特征致使这几个应用转变状态
  • 拥有的数额,不管是通过互连网获得的要么操作数据库拿到(增加和删除改查)的多少,都以财富,将总体数据正是财富是REST区别与其他架构风格的最本质属性
  • 对于REST那种面向能源的架构风格,有人建议一种全新的布局理念,即:面向财富架构(ROA:Resource
    Oriented Architecture)

    • 对互连网上的任性东西都视为财富,他认为2个url正是2个财富比如:

RESTful API,restfulapi

  • REST与技术非亲非故,代表的是一种软件架构风格,REST是Representational
    State Transfer的简称,普通话翻译为“特色状态转移
  • REST从财富的角度类审视整个互连网,它将分布在网络中有个别节点的能源通过U凯雷德L进行标识,客户端应用通过UCR-VL来取得财富的特点,得到这几个特点致使那个使用转变状态
  • 负有的多寡,不管是因而互连网获取的大概操作数据库得到(增加和删除改查)的数量,都是财富,将全体数据正是能源是REST差距与此外框架结构风格的最本质属性
  • 对于REST那种面向能源的架构风格,有人提议一种崭新的协会理念,即:面向财富框架结构(ROA:Resource
    Oriented Architecture)

    • 对网络上的任意东西都实属能源,他认为2个url便是1个财富比如:

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从财富的角度类审视整个互连网,它将分布在网络中某些节点的能源通过URubiconL举办标识,客户端应用通过U瑞鹰L来赢得财富的特色,获得那几个特征致使那几个应用转变状态

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

富有的数据,可是是透过网络获取的依旧操作(增加和删除改查)的数量,都以能源,将全部数据正是能源是REST差距与其他架构风格的最本质属性

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


 

二、RESTful API设计

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

故而,必须有一种统一的建制,方便差异的前端设备与后端进行通讯。那造成API构架的风靡,甚至出现”API
First”的布署性思想。RESTful
API是近期比较成熟的一套互连网应用程序的API设计理论。

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

– 为人家提供劳务

– 前后端分离,二个写vue,3个写后端,他们中间都以透过ajax请求

1、协议

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

2、域名

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

3、版本(**Versioning**)

有道是将API的版本号放入URubiconL。

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路径和U卡宴L参数偶尔有双重。比如,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景逸SUVL。

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

  1. 路径(Endpoint)

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

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

举例来说来说,有3个API提供动物园(zoo)的音讯,还包含种种动物和雇员的信息,则它的路线应该设计成上边那样。

  1. HTTP动词

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

常用的HTTP动词有上边多个(括号里是呼应的SQL命令)。

GET(SELECT):从服务器取出能源(一项或多项)。
POST(CREATE):在服务器新建2个财富。
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路径和U安德拉L参数偶尔有重新。比如,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”
}}
地方代码表示,文书档案中有2个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的版本号放入UQashqaiL。

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

另一种做法是,将版本号放在HTTP头新闻中,但不比放入U中华VL方便和直观。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

就此,必须有一种统一的建制,方便分歧的前端设备与后端进行通讯。那导致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路径和UTucsonL参数偶尔有重新。比如,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奥迪Q7L。

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

另一种做法是,将版本号放在HTTP头音讯中,但不及放入ULX570L方便和直观。Github采用这种做法。

⑨ 、重临结果

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

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会取得1个全体可用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路径和UHighlanderL参数偶尔有再一次。比如,GET
/zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是一模一样的。

方式二:CBV模式

根据django实现的API许多效益都急需大家和好开支,那时候djangorestframework就给我们提供了有利于,直接基于它来回到数据,由此可见原理都以一致的,正是给三个接口也便是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的根目录发出请求,会赢得那样3个文书档案。

{"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是1个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地图