API就是接口必威手机官网,方便不同的前端设备

1、什么是API?

二、域名

有道是尽恐怕将API安排在专项使用域名之下。
https://api.example.com

假设明确API很简短,不会有越来越扩张,可以假造放在主域名下。
https://example.org/api/

方式一: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

 

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

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

全局使用

必威手机官网 7必威手机官网 8

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

settings

必威手机官网 9必威手机官网 10

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里面设置。

必威手机官网 11

相见这些错误就是因为还未有在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('主机列表')

 

作者:阮一峰(http://www.ruanyifeng.com/blog/2014/05/)

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

网络应用程序,分为前端和后端多少个部分。当前的发展趋势,正是前面叁个设备举不胜举(手提式无线电话机、平板、桌面Computer、其余专项使用设备......卡塔 尔(英语:State of Qatar)。
故此,必需有风流倜傥种统生龙活虎的体制,方便不相同的前端设备与后端实行通讯。那产生API构架的风行,以至现身"API First"的设计理念。RESTful API是这段时间可比早熟的意气风发套互连网应用程序的API设计理论。小编原先写过风华正茂篇《理解RESTful架构》,探究怎样明白这一个定义。
明天,小编将介绍RESTful API的规划细节,研讨如何设计划生育机勃勃套合理、好用的API。小编的首要性参照了两篇小说(1,2)。

2、域名

有两种办法

措施风姿洒脱: 尽量将API布署在专项使用域名(会存在跨域难题卡塔尔

https://api.example.com

办法二:假若分明API很简短,不会有更加的扩展,能够设想放在主域名下。

https://example.org/api/

五、HTTP动词

对此能源的具体操作类型,由HTTP动词表示。
常用的HTTP动词有上边八个(括号里是对应的SQL命令卡塔尔国。

GET(SELECT):从服务器取出资源(一项或多项)。
POST(CREATE):在服务器新建一个资源。
PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。
PATCH(UPDATE):在服务器更新资源(客户端提供改变的属性)。
DELETE(DELETE):从服务器删除资源。
还有两个不常用的HTTP动词。
HEAD:获取资源的元数据。
OPTIONS:获取信息,关于资源的哪些属性是客户端可以改变的。

2、应用:

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

可以有三种艺术

三、版本(Versioning)

应该将API的版本号放入UGTC4LussoL。
https://api.example.com/v1/

另风姿洒脱种做法是,将版本号放在HTTP头消息中,但不及放入U奔驰G级L方便和直观。Github选择这种做法。

  • REST与手艺非亲非故,代表的是大器晚成种软件架构风格,REST是Representational State Transfer的简单的称呼,普通话翻译为“天性状态转移
  • REST从能源的角度类审视整个网络,它将遍布在互连网中有些节点的财富通过UCRUISERL进行标记,顾客端应用通过U奥迪Q3L来得到财富的特点,获得那些特征以致这个应用转换状态
  • 怀有的数量,不管是透过网络获得的要么操作数据库获得(增加和删除改查卡塔尔国的数目,都是财富,将一切数据就是能源是REST差距与其余框架结构风格的最本质属性
  • 对于REST这种面向财富的架构风格,有人建议风流浪漫种全新的协会思想,即:面向财富架构(ROA:Resource Oriented Architecture)
    • 对互联网络的随机东西都实属财富,他感觉多少个url就是多个资源举个例子:

九、重返结果

本着不相同操作,服务器向客户重回的结果应该切合以下规范。

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

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

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

上面是有的例证。

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路线和U奥迪Q3L参数不时有重新。例如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的意思是相符的。

End

9、再次来到结果

本着差别操作,服务器向客商再次来到的结果应当相符以下规范

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

四、路径(Endpoint)

路子又称"终点"(endpoint卡塔 尔(英语:State of Qatar),表示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

网络应用程序,分为前端和后端四个部分。当前的发展趋势,正是前面一个设备不计其数(手提式有线电电话机、平板、桌面Computer、其余专项使用设备......卡塔 尔(英语:State of Qatar)。

一、协议

API与顾客的通讯合同,总是利用HTTPs协议。

那么先来简单领会一下

八、错误管理(Error handling卡塔 尔(阿拉伯语:قطر‎

若是状态码是4xx,就应有向客商再次来到出错消息。平时的话,重临的信息中校error作为键名,出错新闻作为键值就能够。
{ error: "Invalid API key"}

本文由必威发布于必威-编程,转载请注明出处:API就是接口必威手机官网,方便不同的前端设备

相关阅读