运用flask、flask-restful开发rest风格的接口,并使用蓝图增加代码的延展性和可扩展性。
本人做为一个测试人员,之前也有写过,想要测试好接口,那必须要知道如何开发一个接口的重要性。
之前也写过通flask或者flask-retful开发接口,但那些只是一些最简单的demo,不具有很好延展性和扩展性。
此次我们带一整个完整的demo
使用flask-retfull,orm,蓝图,来让代码更加具有可塑性。
此次我们实现了5个接口,当然笔者还在不断的完善中。文末会贴出代码的git地址,觉得有用的朋友可以关注一下。
首先看一下我们的代码目录:
db:由于运用的是sqlite数据库,此处为存放数据库文件。
file:模拟的上传文件的操作,凡是通过上传文件接口上传的文件都存在此处。
src:
--common : 写一个公共的方法
--module: 存放相关蓝图
--user : user为本项目的一个蓝图。(如有需要可扩展其它蓝图文件,只需要在主app中注册该蓝图及可)
venv : 本项目的虚拟目录
app :主启动文件
models : 数据库orm
settings : 本项目相关设置
数据库orm的创建,以及flask项目的相关配置,蓝图的使用和注册,这里不过多的讲,我们重点讲一下接口代码的实现方法。
1、查询接口:这里主要是根据名字来查询,并进行了分页的处理。当不传名字参数时,则认为是查询全部数据。
以下是查询使用的orm:
stu=Student.query.filter(and_(Student.name == name, Student.is_del == 0)).paginate(page=page,per_page=num)
参数讲解:name为用户名字,page为页数,per_page为每页条数。
result = []
for s in stu.items:
result.append(s.to_json())
以上是把查询出来的数据进行遍历并赋值给一个列表以便最后返回。
2、添加接口:是根据提交的数据直接把数据插入到数据表中,此处需要注意的是所有数据不能为空。
stu = Student(name=name, sex=sex, age=age, grade=grade, source=source, face=face)
if name and sex and age and grade and source and face:
try:
db.session.add(stu)
db.session.commit()
return make_result()
except:
return make_result(code=Code.DATA_FAIL)
else:
return make_result(code=Code.PARAM_FAIL)
3、上传文件接口:此处是模拟上传,只是把上传的文件保存到了项目的file文件夹下,但此处需要注意是,定义上传文件参数类型的时候需要导入一个包。
from werkzeug.datastructures import FileStorage
4、删除接口:本着不能随意删除数据的原则,我们在创建表的时候,添加一个is_del字段来确定只条数据是否删除。因此删除接口的本质是把这个字段改为1。
5、修改接口:修改接口的是根据表id,把数据查询出来,然后再根据其要修改的字段来进行修改。(原理上和删除接口一样)此处需要注意的是,修改数据不会所有数据都修改,只会修改其中某一条或几条数据,我们接口定义的是,如果修改才传只参数,不修改则不传,因此:
stu = Student.query.filter(Student.id == id).first()
if stu:
if name or sex or age or grade or source or face:
if name:
stu.name = name
if sex:
stu.sex = sex
if age:
stu.age = age
if grade:
stu.grade = grade
if source:
stu.source = source
if face:
stu.face = face
db.session.add(stu)
有些参数就修改,无则不修改。
最后需要说明一点,因为我们写的rest风格的接口,因此返回的数据应该是json格式的,因此我们在创建Orm数库表时,创建了一个to_json()方法,以供使用。
def to_json(self):
return {
'id': self.id,
'name': self.name,
'sex': self.sex,
'age': self.age,
'grade': self.grade,
'source': self.source,
'face': self.face,
'is_del': self.is_del
}
以上就是我们所实现的全部接口。
git址址:https://github.com/gfihdx/flask-restful.git
有兴趣的可以去git clone一下,并关注,后期更新。
下次更新目标,多表的联合查询,及查询数据的格式化方法优化。
注:虽然文章拙劣,但转载请注明出处。
运用flask、flask-restful开发rest风格的接口,并使用蓝图增加代码的延展性和可扩展性。的更多相关文章
- Python flask 基于 Flask 提供 RESTful Web 服务
转载自 http://python.jobbole.com/87118/ 什么是 REST REST 全称是 Representational State Transfer,翻译成中文是『表现层状态转 ...
- 使用 Python 和 Flask 设计 RESTful API
近些年来 REST (REpresentational State Transfer) 已经变成了 web services 和 web APIs 的标配. 在本文中我将向你展示如何简单地使用 Pyt ...
- Restful风格API接口开发springMVC篇
Restful风格的API是一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件.它主要用于客户端和服务器交互类的软件.基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机 ...
- 在Dubbo中开发REST风格的远程调用(RESTful Remoting)
rest 在Dubbo中开发REST风格的远程调用(RESTful Remoting)
- 使用 Python & Flask 实现 RESTful Web API
环境安装: sudo pip install flask Flask 是一个Python的微服务的框架,基于Werkzeug, 一个 WSGI 类库. Flask 优点: Written in Pyt ...
- SpringBoot RestFul风格API接口开发
本文介绍在使用springBoot如何进行Restful Api接口的开发及相关注解已经参数传递如何处理. 一.概念: REST全称是Representational State Transfer,中 ...
- Flask之RESTFul API前后端分离
Flask之RESTFul API前后端分离 一:虚拟环境搭建的两种方式 1 pipenv的使用 pip install --user pipenv安装pipenv在用户目录下 py -m site ...
- 学习python-20191208(2)-Python Flask高级编程开发鱼书_第03章_数据与flask路由
视频06: 定义静态方法的两种方式: 1.在方法上方加上装饰@staticmethod 2.在方法上方加上装饰@classmethod 方法中要加参数cls 如:def search_by_isb ...
- 学习python-20191208(1)-Python Flask高级编程开发鱼书_第03章_数据与flask路由
视频01: 略...... ———————————————————————————————————————————————————————————— 视频02: 搜索需要外部数据源,也就是需要外部的A ...
随机推荐
- Android_YouthArea之ApeendTextView
这次给我自己的项目打个广告:http://sj.qq.com/myapp/detail.htm?apkName=com.youthcommunity 这款APP 不同于SoHOT是积极的,是年轻人的信 ...
- CDH使用Solr实现HBase二级索引
一.为什么要使用Solr做二级索引二.实时查询方案三.部署流程3.1 安装HBase.Solr3.2 增加HBase复制功能3.3创建相应的 SolrCloud 集合3.4 创建 Lily HBa ...
- 【题解】Jury Compromise(链表+DP)
[题解]Jury Compromise(链表+DP) 传送门 题目大意 给你\(n\le 200\)个元素,一个元素有两个特征值,\(c_i\)和\(d_i\),\(c,d \in [0,20]\), ...
- 我的Android进阶之旅------>Ubuntu下不能识别Android设备的解决方法
Bus 001 Device 006: ID 1b20:0c81 MStar Semiconductor, Inc. 今天不知道Ubuntu发了什么疯,昨天还用的好好的,今天就突然不能识别我 ...
- PowerDesigner 125 导致 Word 2007文档内容无法选中以及点击鼠标没用
- 获取系统 SID
版权声明:本文为博主原创文章,未经博主同意不得转载. https://blog.csdn.net/hadstj/article/details/26399533 获取系统 SID ((gwmi win ...
- Java基础教程:对象比较排序
Java基础教程:对象比较排序 转载请标明出处:http://blog.csdn.net/wangtaocsdn/article/details/71500500 有时候需要对对象列表或数组进行排序, ...
- px sp dp 手机尺寸
- 后端CORS解决跨域问题
一 . 为什么会有跨域问题 是因为浏览器的同源策略是对ajax请求进行阻拦了,但是不是所有的请求都给做跨域,像是一般的href 属性,a标签什么的都不拦截. 二 . 解决跨域的方法 解决跨域有两种方法 ...
- 【Leetcode-easy】ZigZag Conversion
思路1:String[numRow]行字符串数组.读取原始字符串每一个字符,设置行变量 nrow和行标志位flag(向下一行为1或向上一行为-1).将该字符连接到数组中对应的行字符串,同时nrow+= ...