flask-restful学习笔记

restful api 前端与后台进行通信的一套规范，使用这套规范可以让前后端开发变得更加轻松
协议
http 或 https
数据传输格式： json
url连接
url链接中，不能有动词(eg:)，只能有名词，并且对于一些名词，如果为负数，应在后面加ｓ
ＨＴＴＰ请求方法：
get:获取
post:新建(eg:用户注册)
put:更新(eg:要求客户端提供所有数据)
patch:更新局部
delete:从服务器上删除资源
状态码：

状态码	原生描述	描述
２００	ＯＫ	服务器响应客户请求
４００	invalid request	用户请求有错误，服务器没有进行新建或自该数据的操作
４０１	Unauthorized	用户没有权限访问这个请求
４０３	Forbidden	因为某些原因禁止访问这个请求
４０４	Not Found	用户发送请求的url不存在
４０６	Not Acceptable	用户请求不被服务器接收（例如服务器需要某字段但客户端没有发送）
５００	internal server error	服务器内部错误，比如出现了一个bug

基本使用：

1. 从flask_restful中导入Api，来创建一个api对象。
2. 写一个视图函数，让他继承自Resource，然后在这个里面，使用你想要的请求方式来定义相应的方法，比如你想要将这个视图只能采用post请求，那么就定义一个post方法。
3. 使用api.add_resource添加视图与url。
   示例代码如下：

class LoginView(Resource):
    def post(self,username=None):
        return {"username":"zhangsan"}

api.add_resource(LoginView,'/login/<username>/','/regist/')＃映射到url

注意事项：

• 如果你想返回json数据，那么就使用flask_restful，如果你是想渲染模版，那么还是采用之前的方式，就是app.route的方式。
• url还是跟之前的一样，可以传递参数。也跟之前的不一样，可以指定多个url。
• endpoint是用来给url_for反转url的时候指定的。如果不写endpoint，那么将会使用视图的名字的小写来作为endpoint。

参数验证：

Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包，叫做reqparse。以下是基本用法：

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

add_argument可以指定这个字段的名字，这个字段的数据类型等。以下将对这个方法的一些参数做详细讲解：

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

其中的type，可以使用python自带的一些数据类型，也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。比如一些常用的：
7. url：会判断这个参数的值是否是一个url，如果不是，那么就会抛出异常。
8. regex：正则表达式。
9. date：将这个字符串转换为datetime.date数据类型。如果转换不成功，则会抛出一个异常。

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

class ProfileView(Resource):
    resource_fields = {
        'username': fields.String,
        'age': fields.Integer,
        'school': fields.String
    }

    @marshal_with(resource_fields)
    def get(self,user_id):
        user = User.query.get(user_id)
        return user

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

重命名属性：

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

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

默认值：

在返回一些字段的时候，有时候可能没有值，那么这时候可以在指定fields的时候给定一个默认值，示例代码如下：

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

复杂结构：

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

class ArticleView(Resource):

    resource_fields = {
        'aritlce_title':fields.String(attribute='title'),
        'content':fields.String,
        'author': fields.Nested({
            'username': fields.String,
            'email': fields.String
        }),
        'tags': fields.List(fields.Nested({
            'id': fields.Integer,
            'name': fields.String
        })),
        'read_count': fields.Integer(default=80)
    }

    @marshal_with(resource_fields)
    def get(self,article_id):
        article = Article.query.get(article_id)
        return article

Flask-restful注意事项：

1. 在蓝图中，如果使用flask-restful，那么在创建Api对象的时候，就不要再使用app了，而是使用蓝图。
2. 如果在flask-restful的视图中想要返回html代码，或者是模版，那么就应该使用api.representation这个装饰器来定义一个函数，在这个函数中，应该对html代码进行一个封装，再返回。示例代码如下：

@api.representation('text/html')
def output_html(data,code,headers):
    print(data)
    # 在representation装饰的函数中，必须返回一个Response对象
    resp = make_response(data)
    return resp

class ListView(Resource):
    def get(self):
        return render_template('index.html')
api.add_resource(ListView,'/list/',endpoint='list')