简介

REST：REpresentational State Transfer，英语的直译就是“表现层状态转移”。

解词：

Resource：资源，即数据。

Representational：某种表现形式，比如用JSON，XML，JPEG等。

State Transfer：状态变化。通过HTTP动词实现。

简述

RESTful API就是REST风格的API。那么在什么场景下使用RESTfulAPI呢？

在当今的互联网应用的前端展示媒介很丰富。有手机、有平板电脑还有PC以及其他的展示媒介。那么这些前端接收到的用户请求统一由一个后台来处理并返回给不同的前端肯定是最科学和最经济的方式，RESTful API就是一套协议来规范多种形式的前端和同一个后台的交互方式。

RESTful API由后台也就是SERVER来提供前端来调用。前端调用API向后台发起HTTP请求，后台响应请求将处理结果反馈给前端。也就是说RESTful是典型的基于HTTP的协议。那么RESTful API有哪些设计原则和规范呢？<

  • 资源。首先是弄清楚资源的概念。资源就是网络上的一个实体，一段文本，一张图片或者一首歌曲。资源总是要通过一种载体来反应它的内容。文本可以用TXT，也可以用HTML或者XML、图片可以用JPG格式或者PNG格式，JSON是现在最常用的资源表现形式。
  • 统一接口。RESTful风格的数据元操CRUD（create,read,update,delete）分别对应HTTP方法：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源，这样就统一了数据操作的接口。
  • URI。可以用一个URI（统一资源定位符）指向资源，即每个URI都对应一个特定的资源。要获取这个资源访问它的URI就可以，因此URI就成了每一个资源的地址或识别符。一般的，每个资源至少有一个URI与之对应，最典型的URI就是URL。
  • 无状态。所谓无状态即所有的资源都可以URI定位，而且这个定位与其他资源无关，也不会因为其他资源的变化而变化。有状态和无状态的区别，举个例子说明一下，例如要查询员工工资的步骤为第一步：登录系统。第二步：进入查询工资的页面。第三步：搜索该员工。第四步：点击姓名查看工资。这样的操作流程就是有状态的，查询工资的每一个步骤都依赖于前一个步骤，只要前置操作不成功，后续操作就无法执行。如果输入一个URL就可以得到指定员工的工资，则这种情况就是无状态的，因为获取工资不依赖于其他资源或状态，且这种情况下，员工工资是一个资源，由一个URL与之对应可以通过HTTP中的GET方法得到资源，这就是典型的RESTful风格。

例子

GET:http://www.xxx.com/source/id 获取指定ID的某一类资源。
GET:http://www.xxx.com/friends/123表示获取ID为123的会员的好友列表。如果不加id就表示获取所有会员的好友列表。
POST:http://www.xxx.com/friends/123表示为指定ID为123的会员新增好友。

规范补充

1.应该将API的版本号放入URL。GET:http://www.xxx.com/v1/friend/123。或者将版本号放在HTTP头信息中。
2.URL中只能有名词而不能有动词，操作的表达是使用HTTP的动词GET,POST,PUT,DELETEL。URL只标识资源的地址，既然是资源那就是名词了。

3.如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。?limit=10：指定返回记录的数量、?page=2&per_page=100：指定第几页，以及每页的记录数。

RESTful web service

HTTP方法

动作

例子

GET

获取资源信息

http://example.com/api/orders（检索订单清单）

GET

获取资源信息

http://example.com/api/orders/123（检索订单 #123）

POST

创建一个资源

http://example.com/api/orders（使用带数据的请求，创建一个新的订单）

PUT

更新一个资源

http://example.com/api/orders/123（使用带数据的请求，更新#123订单）

DELETE

删除一个资源

http://example.com/api/orders/123（删除订单#123）

设计一个简单的web service

第一步，是要规划URL
http://127.0.0.1/web/nlp/test/api/v1.0/

第二步，从一个简单的例子开始，python代码如下：

#!flask/bin/python
from flask import Flask,jsonify,make_response,abort,request

#模块别名
app = Flask(__name__)
#创建一个数组做测试
subjects = ['a','b']

#处理对应地址的请求-返回数组全部的信息
@app.route('/web/nlp/test/api/v1.0/subjects',methods=['GET'])
def get_subjects():
    return jsonify({'subjects': subjects})

#将传入的下标作为索引，查询数组中的内容，并调用友好的异常处理
@app.route('/web/nlp/test/api/v1.0/subjects/<int:sub_id>',methods=['GET'])
#注意这里的传参,<int:sub_id>,这种通过url接受的参数，访问时也只能通过拼url传入
def get_task_by_id(sub_id):
    if sub_id >= len(subjects):
        abort(404)
    return jsonify({'subjects': subjects[sub_id]})

#404异常的友好处理
@app.errorhandler(404)
def not_found(error):
    return make_response(jsonify({'error': 'Not found'}),404)

if __name__ == '__main__':
    app.run(debug=True)

注：拼url的传参方式，在调用时是使用对应的方法

下面是调用实例

curl -i --header "Accept-Language: zh-cn" -X GET http://127.0.0.1:5000/hrjlk/nlp/test/api/v1.0/subjects
输出(返回了数据的全部信息，对应第一个接口)
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 52
Server: Werkzeug/0.14.1 Python/3.6.6
Date: Sun, 04 Nov 2018 13:18:59 GMT

{
  "subjects": [
    "a",
    "b"
  ]
}
curl -i --header "Accept-Language: zh-cn" -X GET http://127.0.0.1:5000/hrjlk/nlp/test/api/v1.0/subjects/1
输出(返回数组中下标为1的数据)
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 22
Server: Werkzeug/0.14.1 Python/3.6.6
Date: Sun, 04 Nov 2018 13:30:04 GMT

{
  "subjects": "b"
}

curl的调用参数也可以少传一些，做简单测试：

GET模式

curl "http://127.0.0.1:5000/web/nlp/test/api/v1.0//subjects"
或者是
curl "http://127.0.0.1:5000/web/nlp/test/api/v1.0//subjects/1"

POST模式

想要服务接收POST方式提交的信息，只需要调整methods即可，参照如下例子：

@app.route('/web/nlp/test/api/v1.0/subjects',methods=['GET'])
或
methods=['POST']
methods=['GET','POST']

调用方式是：

curl -X "POST" "http://127.0.0.1:5000/web/nlp/test/api/v1.0/subjects"

补充

jsonify与json.dumps的区别

jsonify返回的是Content-Type是：application/json
json.dumps返回的是：text/html