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 相关文章推荐
kNN算法python实现和简单数字识别的方法
Nov 18 Python
Python修改MP3文件的方法
Jun 15 Python
Python爬虫抓取手机APP的传输数据
Jan 22 Python
Python cookbook(字符串与文本)针对任意多的分隔符拆分字符串操作示例
Apr 19 Python
浅谈Series和DataFrame中的sort_index方法
Jun 07 Python
Python统计纯文本文件中英文单词出现个数的方法总结【测试可用】
Jul 25 Python
使用python的pandas库读取csv文件保存至mysql数据库
Aug 20 Python
解析Python3中的Import
Oct 13 Python
Python 支持向量机分类器的实现
Jan 15 Python
Pandas把dataframe或series转换成list的方法
Jun 14 Python
python分分钟绘制精美地图海报
Feb 15 Python
Python代码实现双链表
May 25 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搜索加分页
2016/10/12 PHP
基于jquery的设置页面文本框 只能输入数字的实现代码
2011/04/19 Javascript
基于jquery自定义图片热区效果
2012/07/21 Javascript
jquery中get和post的简单实例
2014/02/04 Javascript
javascript trim函数在IE下不能用的解决方法
2014/09/12 Javascript
jQuery实现鼠标划过修改样式的方法
2015/04/14 Javascript
JS中Location使用详解
2015/05/12 Javascript
JS实现超简洁网页title标题跑动闪烁提示效果代码
2015/10/23 Javascript
AngularJS 简单应用实例
2016/07/28 Javascript
原生js实现手风琴功能(支持横纵向调用)
2017/01/13 Javascript
nodejs个人博客开发第二步 入口文件
2017/04/12 NodeJs
Ionic2调用本地SQlite实例
2017/04/22 Javascript
vue-cli3 项目从搭建优化到docker部署的方法
2019/01/28 Javascript
Vue.js递归组件实现组织架构树和选人功能案例分析
2019/07/03 Javascript
微信小程序保持session会话的方法
2020/03/20 Javascript
python获取本地计算机名字的方法
2015/04/29 Python
Python的Django框架中的数据库配置指南
2015/07/17 Python
Django返回json数据用法示例
2016/09/18 Python
Django 2.0版本的新特性抢先看!
2018/01/05 Python
强悍的Python读取大文件的解决方案
2019/02/16 Python
python3+selenium自动化测试框架详解
2019/03/17 Python
Python Pandas中根据列的值选取多行数据
2019/07/08 Python
详解python列表(list)的使用技巧及高级操作
2019/08/15 Python
Pandas缺失值2种处理方式代码实例
2020/06/13 Python
matplotlib基础绘图命令之errorbar的使用
2020/08/13 Python
web页面录屏实现
2019/02/12 HTML / CSS
大学生毕业自我评价范文分享
2013/11/07 职场文书
索桥的故事教学反思
2014/02/06 职场文书
读群众路线心得体会
2014/03/07 职场文书
运动会演讲稿200字
2014/08/25 职场文书
2014年度安全工作总结
2014/12/04 职场文书
2015年护士长个人工作总结
2015/04/24 职场文书
2016班级元旦联欢会开幕词
2016/03/04 职场文书
详解Mysql和Oracle之间的误区
2021/05/18 MySQL
Python pandas求方差和标准差的方法实例
2021/08/04 Python
Nginx开源可视化配置工具NginxConfig使用教程
2022/06/21 Servers