Restful API规范与Flask-Restful插件

Restful API规范

是用于在前端与后台进行通信的一套规范，使用这个规范可以让前后端开发变得更加轻松。

协议

采用http或者https协议

数据传输格式

数据之间传输的格式应该都使用ison，而不使用xml

url连接

url连接中，不能有动词，只能有名词，并且对于一些名词，如果出现复数胡，那么应该在后面加s。

HTTP请求的方法

• GET：从服务器中获取资源
• POST：在服务器中新创建一个资源
• PUT：在服务器中更新资源（客户端提供所有改变后的数据）
• PATCH：在服务器上更新资源（客户端只提供需要改变的属性）
• DELETE: 从服务器上删除资源

示例

1. GET/user/：获取所有用户
2. POST/user/：新建一个用户
3. GET/user/id/：根据id获取一个用户
4. PUT/user/id：更新某个id的用户的信息（需要提供用户的所有信息）
5. PATCH/user/id：更新某个id用户的信息（只需要提供需要改变的信息）
6. DELETE/user/id：删除一个用户

Flask-Restful插件

Flask-Restful是一个专门来写restful api的一个插件，使用它可以快速的继承restful api功能。在app的后台以及纯api的后台中，这个插件可以帮助我们节省很多空间。当然。如果在普通的网站中，这个插件就没啥打作用，因为在普通的网页开发中，是需要去渲染HTML代码的，而Flask-Restful在每个请求中都是返回json格式的数据。

安装

Flask-Restful需要在Flask 0.8以上的版本，在python2或者python3.3上运行，通过pip install flask-restful即可安装。

定义restful的视图

如果使用Flask-Restful，那么定义视图函数的时候，就要继承自Flask-Restful.Resource类，然后再根据当前请求的method来定义相应的方法。比如期望客户端是使用get方法发送过来的请求，那么就定义一个get方法，类似于MethodView。

from flask import Flask, render_template, url_for
from flask_restful import Api, Resource

app = Flask(__name__)
# 用api来指定app
api = Api(app)

class IndeView(Resource):
	def get(self):
	return ("username": "happy")

api.add_resource(IndeView,'/',endpoint='index')

注意事项

• endpoint是用来给url_for反转的时候指定的。如果不写endpoint，那么将会使用视图的名字的小写来作为endpoint。
• add_resource的第二个参数就是访问这个视图函数的url，这个url可以跟之前的route一样，可以传递参数，并且还有一点不同的是，这个方法可以传递多个url来指定这个视图函数。

参数解析

Flas-Restful插件提供了类似WTForm来验证提交的数据是否合法的包，叫做reqparse。

parser = reqparse.RequestParser()
parser.add_argument('username',type=str,help='请输入用户名')
args = parser.parse_args()

add_argument可以指定这个字段的名字，这个字段的数据类型。

• default：默认值，如果这个参数没有值，那么将使用这个参数指定的值。
• required：是否必须，默认为False，如果设为True，那么这个参数必须提交上来。
• type：这个参数的数据类型，如果指定，那么将使用指定的数据类型来强制转换提交上来的值。
• choices：选项。提交上来的值只有满足这个选项中的值才符合验证通过，否则验证不通过。
• help：错误信息，如果验证失败后，将会使用这个参数指定的值作为错误信息。
• trim：是否要去掉前后空格。

输出字段

对于一个视图函数，你可以指定好一些字段用于返回，以后可以使用ORM模型或者自定义的模型的时候，他会自动地获取模型中地相应地字段，生成json数据，然后再返回给客户端，这其中需要导入flask_restful.marshal_with装饰器，并且需要写一个字典，来指示需要返回地字段，以及该字段地数据类型。

class ProfileView(Resourse):
	resourse_fields= {
	    'username': fileds.String,
	    'age': fields.Integer,
	    'school': fields.String
	    }
    @marshal_with(resourse_fields)
    def get(self,url_id):
 	user = User.query.get(user_id)
 	return user

在get方法中，返回user地时候，flask_restful会自动地读取user模型上地username以及age还有school属性。组装成一个json格式地字符串返回给客户端。

默认值

在返回一些字段地时候，有时候可能没有值，那么这个时候可以在指定fields的时候给定一个默认值。

resourse_fields={
    'age': fields.Integer(default=18)
    }

复杂结构

有时候想要在返回地数据格式中，形成比较复杂的结构，那么可以使用一些特殊的字段来实现。比如要在一个字段中放置一个列表，那么可以使用fields.List，比如在一个字段下面又是一个字典，那么可以使用fields.Nested。

class ProfileView(Resource):
	resourse_fields = {
	   'username': fields.String,
	   'age': fields.Integer,
	   'school':fields.String,
	   'tags': fields.List(fields,String,
	   'more':fields.Nested({
	      'signature':fields.String
	      )}
	      }

重命名

很多时候你面向公众的字段名称是不同于内部的属性名。使用arttribute可以配置这种映射。比如现在想要返回user.school中的值，但是在返回给外面的时候，想以education返回回去，那么可以这样写：

resourse_fields = {
      'education': fields.String(attribute='school')
      }

数据库8！！！！！