RESTful API

1.什么是restful?

• REST与技术无关，代表的是一种软件架构风格,Rest是（Representational State Transfer的简称）中文翻译“表征状态转移”
• 对于REST这种面向资源的架构风格，有人提出一种全新的结构理念即：面向资源框架
• 互联网上任意东西都视为资源，他认为一个url就是一个资源

2.了解什么是API

什么是API?
api就是接口,提供的url,接口有两个用途：

• 为别人提供服务
• 前后端分离，一个写vue,一个写后端，他们之间都是通过ajax请求

3.Restful API设计

网络应用程序，分为前端和后端两部分，当前发展趋势就是前端设备的层出不穷（手机，平板,桌面电脑）.
restful是目前比较成熟的一套互联网应用程序的api设计理论

协议

API与用户的通信协议,总是使用https协议.

域名

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

https://api.example.com

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

https://example.org/api/

版本

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

路径

路径又称终点，表示API的具体网址
在restful架构中，每个网址代表一种资源，所以网址中不能有名词只能有名词，而且所有的名词往往与数据库表格名对应，一般来说，数据库中表都是同种记录的“集合”所以api中的名词应该使用复数

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

HTTP动词

对于资源的具体操作类型，由HTTP动词表示.
常用的http动词有下面5个（括号里对应的是sql命令）

GET（SELECT）：从服务器取出资源（一项或多项）。即获取数据
POST（CREATE）：在服务器新建一个资源。 即添加数据
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。即更新数据
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。即更新数据
DELETE（DELETE）：从服务器删除资源  。即删除数据

下面是一些例子：

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：指定筛选条件
··

状态码

链接：https://www.jianshu.com/p/d398d920f24f

错误处理

如果状态码是4XX就应该向用户返回错误信息，一般来说，返回的信息中用error作为键,出错信息为键值既可

{
    error: "Invalid API key"
}

返回结果

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

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

超媒体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"
}

4.基于Django实现API

有两种实现方式FBV和CBV但是主要还是用CBV的方式
app01/urls

from app02 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

views

RESTful API