12.Flask-Restful
定义Restful的视图
安装:pip install flask-restful
如果使用Flask-restful,那么定义视图函数的时候,就要继承flask_restful.Resourse类,然后再根据当前请求的method来定义相应的方法。比如期望客户端是使用get方法发送过来的请求,那么就定义一个get方法。
from flask import Flask
from flask_restful import Api,Resource app = Flask(__name__)
api = Api(app) #用Api来绑定app class LoginView(Resource):
def post(self):
return {'username':'derek'}
api.add_resource(LoginView,'/login/',endpoint="login") @app.route('/')
def index():
return 'Hello World!' if __name__ == '__main__':
app.run(debug=True)
说明:
- 从flask_restful中导入一个Api,来创建一个api对象。
- 写一个视图函数,让它继承自Resource,然后定义相应的方法。
- endpoint是用来给url_for反转url的时候指定的。如果不写endpoint,那么将会视图函数的名字的小写来作为endpoint.
- add——resource的第二个参数是访问这个视图函数的url,这个url跟之前的route一样,可以传递参数,并且还有一点不同的是,这个方法可以传递多个url来指定这个视图函数。
- 如果想返回json数据,那么就是用flask_restful,如果是渲染模板,还是采用之前的方式。
参数认证
Flask-Restful插件提供了类似WTForms来验证提交的数据是否合法的包,叫做reqparse。
from flask import Flask
from flask_restful import Api,Resource,reqparse,inputs app = Flask(__name__)
api = Api(app) class LoginView(Resource):
def post(self):
parser = reqparse.RequestParser()
parser.add_argument('username',type=str,help='用户名验证错误',default='xxx',trim=True)
parser.add_argument('password',type=str,help='密码验证错误',required=True)
parser.add_argument('gender',type=str,choices=['male','famale'])
parser.add_argument('home_page',type=inputs.url,help=('个人中心链接错误'))
parser.add_argument('birthday',type=inputs.date)
args = parser.parse_args()
print(args)
return {'username':'derek'} api.add_resource(LoginView,'/login/',endpoint="login") @app.route('/')
def index():
return 'Hello World!' if __name__ == '__main__':
app.run(debug=True)
参数说明:
- default:默认值,如果这个参数没有值,那么将使用这个参数指定的值。
- required:是否必须。默认为False,如果设置为True,那么这个参数就必须提交上来。
- type:这个参数的数据类型,如果指定,那么将使用指定的数据类型来强制转换提交上来的值。
- choices:选项。提交上来的值只有满足这个选项中的值才符合,否则验证不通过。
- help:错误信息。如果验证失败后,将会使用这个参数指定的值作为错误信息。
- trim:是否去掉前后空格。
其中的type,可以使用python自带的一些数据类型,也可以使用flask_restful.inputs下的一些特定的数据类型来强制转换。比如一些常用的:
- url:会判断这个参数的值是否是一个url,如果不是,就会抛出异常。
- regex:正则表达式。
- date:将这个字符串转换为datetime.date数据类型,如果转换不成功,则会抛出一个异常。
标准化返回参数
输出字段
对于一个视图函数,你可以指定好一些字段用于返回。以后可以使用orm模型或者自定义的模型的时候,它会自动的获取模型的相应的字段,生成json数据,然后再返回给客户端。这其中需要导入flask_restful.marshal_with装饰器。并且需要些一个字典,来指示需要返回的字段,以及该字段的数据类型。
简单实例:
from flask_restful import Resource,fields,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属性。组成一个json格式的字符串返回给客户端。
重命名属性
很多时候你面向公众的字段名称是不同于内部的属性名,使用attribute可以配置这种映射。比如现在想要返回user.sckool的值,但是在返回给外面的时候,想以education返回回去,那么可以这样写:
resource_fields = {
'username':fields.String,
'age':fields.String
'education':fields.String(attribute='school') #重命名属性
}
默认值
在返回一些字段的时候,有时候可能没有值,那么这时候可以指定fields的时候给定一个默认值。
resource_fields = {
'username':fields.String,
'age':fields.Integer(default=18), # 默认值
'education':fields.String(attribute='school')
}
复杂结构
有时候想要在返回的数据格式中,形参比较复杂的结构。那么可以使用一些特殊的字段来实现。比如要在一个字段中防止一个列表,那么可以使用fields.list;比如在一个字段下面又是一个字典,那么可以使用fields.Nested.
简单实例:
resource_fields = {
'username':fields.String,
'age':fields.Integer(default=18), # 默认值
'education':fields.String(attribute='school'), #重命名属性
'tags':fields.List(fields.String),
'more':fields.Nested({
'signature':fields.String
})
}
12.Flask-Restful的更多相关文章
- Python Flask Restful
Flask Restful 1.flask restful 在flask基础上进行一些封装,主要用于实现restful接口 2.restful的理解 1)URI(统一资源标识符):每一个URI代表一 ...
- 使用swagger 生成 Flask RESTful API
使用swagger 生成 Flask RESTful API http://www.voidcn.com/article/p-rcvzjvpf-e.html swagger官网 https://swa ...
- Flask restful源码分析
Flask restful的代码量不大,功能比较简单 参见 http://note.youdao.com/noteshare?id=4ef343068763a56a10a2ada59a019484
- 如何用rflask快速初始化Flask Restful项目
如何用rflask快速初始化Flask Restful项目 说明 多啰嗦两句 我们在创建flask项目的时候,使用pycharm创建出来的项目比较简陋,而且随着项目的功能完善,项目目录结构会比较多,多 ...
- [flask]Restful接口测试简单的应用
#!/usr/bin/env python # -*- coding: utf-8 -*- # @Author : shenqiang from flask import Flask,make_res ...
- 快速创建Flask Restful API项目
前言 Python必学的两大web框架之一Flask,俗称微框架.它只需要一个文件,几行代码就可以完成一个简单的http请求服务. 但是我们需要用flask来提供中型甚至大型web restful a ...
- python Flask restful框架
框架地址:https://github.com/flask-restful/flask-restful 文档:http://flask-restful.readthedocs.io/en/0.3.5/ ...
- Flask Restful服务简单实现
官网:http://flask.pocoo.org/docs/1.0/quickstart/#routing 1.安装 windows下:pip3 install Flask 具体参照:windows ...
- Flask RESTful API搭建笔记
之前半年时间,来到项目的时候,已经有一些东西,大致就是IIS+MYSQL+PHP. 所以接着做,修修补补,Android/iOS与服务器数据库交换用PHP, Web那边则是JS+PHP,也没有前后端之 ...
- 七十八:flask.Restful之flask-Restful标准化返回参数以及准备数据
对于一个视图函数,可以指定好数据结构和字段用于返回,以后使用ORM模型或者自定义的模型的时候,它会自动获取模型中相应的字段,生成json数据,然后再返回给前端,这需要导入flask_restful.m ...
随机推荐
- LVDS、CVBS
LVDS(Low Voltage Differential Signaling) 是一种低压差分信号技术接口.它是为克服以TTL电平方式传输宽带高码率数据时功耗大.EMI电磁干扰大等缺点而研制的一种数 ...
- Python-第一篇-python初识及变量
<work smart>主动分享成果和经验,与同伴共同成长</smart work> 启文:使用20多种编程语言,对大家说节日快乐 万国码使用16位(至少)表示内容: ASCI ...
- hadoop hdfs ha 模式
这是我自己在公司一个搭建公司大数据框架是自己的选项,在配置yarn ha 出现了nodemanager起不来的问题于是我把yarn搭建为普通yarn 如果有人解决 高yarn的nodemanager问 ...
- SpringBoot加Poi仿照EasyPoi实现Excel导出
POI提供API给Java程序对Microsoft Office格式档案读和写的功能,详细功能可以直接查阅API,因为使用EasyPoi过程中总是缺少依赖,没有搞明白到底是什么坑,索性自己写一个简单工 ...
- mysql数据库 ,java 代码巧妙结合提升系统性能。
查询频繁的表t_yh_transport_task 保证数据量最少,增加查询效率, 常用于查询的字段增加索引, 每日定时移动数据 <!-- 医院系统预约任务历史删除定时器 --> & ...
- 通过s3cmd上传css文件到s3导致样式加载失败
情景说明: 将css文件上传到aws s3存储桶中,通过浏览器访问页面,发现css文件渲染失败. 通过浏览器工程模式发现css为 Content-Type: text/html,正确的 Content ...
- VB.NET或C#报错:You must hava a license to use this ActiveX control.
VB.NET或者C# winform开发时,如果使用了Microsoft Visual Basic 6.0 ActiveX,并动态创建该控件实例,那么程序移植到没有安装Visual Basic 6.0 ...
- Egret的容器--删除对象,遮罩
class P91F extends egret.Sprite { public constructor() { super(); this.addEventListener(egret.Event. ...
- tomcat注册服务
转自https://blog.csdn.net/wangmx1993328/article/details/81013715 在 tomcat 的 bin 目录下可以看到一个 service.bat ...
- 在Codeblocks下配置GoogleTest单元测试工具
开发工具 我和我的组员的都是使用的是大一老师推荐的codeblocks,所以,就愉快的决定了工具统一为codeblocks,语言C++. 测试单元 老师推荐的是JUnit和VSTS工具,但同学们从大一 ...