python Flask实现restful api service


Posted in Python onDecember 04, 2017

一直在用node.js做后端,要逐步涉猎大数据范围,注定绕不过python,因此决定把一些成熟的东西用python来重写,一是开拓思路、通过比较来深入学习python;二是有目标,有动力,希望能持之以恒的坚持下去。

项目介绍

用python语言来写一个restful api service,数据库使用mysql。因为只做后端微服务,并且ORM的实现方式,采用自动生成SQL的方式来完成,因此选择了轻量级的flask作为web框架。如此选择,主要目的是针对中小规模的网络应用,能充分利用关系数据库的种种优势,来实现丰富的现代互联网应用。

REST的六个特性:

  1. Client-Server:服务器端与客户端分离。
  2. Stateless(无状态):每次客户端请求必需包含完整的信息,换句话说,每一次请求都是独立的。
  3. Cacheable(可缓存):服务器端必需指定哪些请求是可以缓存的。
  4. Layered System(分层结构):服务器端与客户端通讯必需标准化,服务器的变更并不会影响客户端。
  5. Uniform Interface(统一接口):客户端与服务器端的通讯方法必需是统一的。
  6. Code on demand(按需执行代码?):服务器端可以在上下文中执行代码或者脚本

restful api

restful api 的概念就不介绍了。这里说一下我们实现协议形式:

[GET]/rs/user/{id}/key1/value1/key2/value2/.../keyn/valuen     
[POST]/rs/user[/{id}]     
[PUT]/rs/user/{id}
[DELETE]/rs/user/{id}/key1/value1/key2/value2/.../keyn/valuen

说明:

  1. rs为资源标识;
  2. 第二节,user,会被解析为数据库表名;
  3. 查询时,id为空或0时,id会被忽略,即为列表查询;
  4. 新建和修改,除接收form表单外,url中的id参数也会被合并到参数集合中;
  5. 删除同查询。

让flask支持正则表达式

flask默认路由不支持正则表达式,而我需要截取完整的URL自己来解析,经查询,按以下步骤很容易完成任务。

  1. 使用werkzeug库 :from werkzeug.routing import BaseConverter
  2. 定义转换器:
class RegexConverter(BaseConverter):

  def __init__(self, map, *args):
    self.map = map
    self.regex = args[0]
  1. 注册转换器 : app.url_map.converters['regex'] = RegexConverter
  2. 用正则来截取url : @app.route('/rs/<regex(".*"):query_url>', methods=['PUT', 'DELETE', 'POST', 'GET'])

几点疑问:

  1. 正则(.*)理论上应该是匹配任何除回车的所有字符,但不知道为什么,在这里不识别问号(?)
  2. 我用request.data来取表单数据,为何request.form取不到?
  3. '/rs/<regex("."):query_url>'后若加个反斜杠('/rs/<regex("."):query_url>/'),request.data就取不到数据,为什么?

解析json数据

解析json数据很容易,但我需要对客户端送上来的数据进行校验,下面是用异常处理又只解析一次的解决方案。

def check_json_format(raw_msg):
  try:
    js = json.loads(raw_msg, encoding='utf-8')
  except ValueError:
    return False, {}
  return True, js

URL解析

按既定协议解析URL,提取表名,为生成sql组合参数集合。

@app.route('/rs/<regex(".*"):query_url>', methods=['PUT', 'DELETE', 'POST', 'GET'])
def rs(query_url):
  (flag, params) = check_json_format(request.data)

  urls = query_url.split('/')
  url_len = len(urls)
  if url_len < 1 or url_len > 2 and url_len % 2 == 1:
    return "The params is wrong."

  ps = {}
  for i, al in enumerate(urls):
    if i == 0:
      table = al
    elif i == 1:
      idd = al
    elif i > 1 and i % 2 == 0:
      tmp = al
    else:
      ps[tmp] = al

  ps['table'] = table
  if url_len > 1:
    ps['id'] = idd
  if request.method == 'POST' or request.method == 'PUT':
    params = dict(params, **{'table': ps.get('table'), 'id': ps.get('id')})
  if request.method == 'GET' or request.method == 'DELETE':
    params = ps
  return jsonify(params)

完整代码

git clone https://github.com/zhoutk/pyrest.git
cd rest
export FLASK_APP=index.py
flask run

小结

今天利用flask完成了web基础架构,能够正确解析URL,提取客户端提交的数据,按请求的不同方式来组合我们需要的数据。希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
采用Psyco实现python执行速度提高到与编译语言一样的水平
Oct 11 Python
Python实现Youku视频批量下载功能
Mar 14 Python
Python实现在线暴力破解邮箱账号密码功能示例【测试可用】
Sep 06 Python
python实现控制台打印的方法
Jan 12 Python
200行python代码实现2048游戏
Jul 17 Python
python中dict()的高级用法实现
Nov 13 Python
python运用pygame库实现双人弹球小游戏
Nov 25 Python
python实现tail实时查看服务器日志示例
Dec 24 Python
解决Tensorflow 内存泄露问题
Feb 05 Python
python简单利用字典破解zip文件口令
Sep 07 Python
python在地图上画比例的实例详解
Nov 13 Python
PyCharm2020.3.2安装超详细教程
Feb 08 Python
浅谈Python中带_的变量或函数命名
Dec 04 #Python
Python中对象的引用与复制代码示例
Dec 04 #Python
Python3 Random模块代码详解
Dec 04 #Python
利用python爬取斗鱼app中照片方法实例
Dec 03 #Python
CentOS 6.5中安装Python 3.6.2的方法步骤
Dec 03 #Python
python3利用smtplib通过qq邮箱发送邮件方法示例
Dec 03 #Python
Python中类的初始化特殊方法
Dec 01 #Python
You might like
php使用异或实现的加密解密实例
2013/09/04 PHP
php读取excel文件示例分享(更新修改excel)
2014/02/27 PHP
PHP实现递归无限级分类
2015/10/22 PHP
让你的PHP7更快之Hugepage用法分析
2016/05/31 PHP
php使用Jpgraph创建3D饼形图效果示例
2017/02/15 PHP
javascript radio 联动效果
2009/03/04 Javascript
JS 动态加载脚本的4种方法
2009/05/05 Javascript
JQuery Tips(2) 关于$()包装集你不知道的
2009/12/14 Javascript
JavaScript学习笔记(十)
2010/01/17 Javascript
js获取客户端外网ip的简单实例
2013/11/21 Javascript
加载列表时jquery获取ul中第一个li的属性
2014/11/02 Javascript
js中取得变量绝对值的方法
2015/01/03 Javascript
js控制元素显示在屏幕固定位置及监听屏幕高度变化的方法
2015/08/11 Javascript
最丑的时钟效果!js canvas时钟制作方法
2016/08/15 Javascript
js实现select选择框效果及美化
2016/08/19 Javascript
浅谈Vue响应式(数组变异方法)
2018/05/07 Javascript
Vue项目中使用flow做类型检测的方法
2020/03/18 Javascript
vue基础知识--axios合并请求和slot
2020/06/04 Javascript
js实现鼠标点击飘爱心效果
2020/08/19 Javascript
Python设计模式之解释器模式原理与用法实例分析
2019/01/10 Python
Python3实现的反转单链表算法示例
2019/03/08 Python
pymongo中聚合查询的使用方法
2019/03/22 Python
python中update的基本使用方法详解
2019/07/17 Python
pytorch查看通道数 维数 尺寸大小方式
2020/05/26 Python
如何使用 Python 读取文件和照片的创建日期
2020/09/05 Python
Python requests接口测试实现代码
2020/09/08 Python
使用CSS3制作饼状旋转载入效果的实例
2015/06/23 HTML / CSS
关于打架的检讨书
2014/01/17 职场文书
写给老婆的检讨书
2014/02/21 职场文书
职业女性的职业规划
2014/03/04 职场文书
法人委托书范本
2014/04/04 职场文书
五一口号
2014/06/19 职场文书
2015年医院保卫科工作总结
2015/07/23 职场文书
2016年暑假学生家长评语
2015/12/01 职场文书
导游词之吉林吉塔
2019/11/11 职场文书
Python合并pdf文件的工具
2021/07/01 Python