普遍程序员给大家的印象都是穿衣打扮很out,但是他们对于新技术和数码产品的追求绝对是很in的。
-----我说的
前言:这次用的web框架是Tornado,webargs的中文例子还是挺少的,我起个头,接下来指定有很多抄袭的
1 获取参数的基本操作
在官网中有两种一种是使用装饰器一种是声明parse实例。
既然有两种方式,那就要思考到底哪一种更加的优雅。在restful的风格的大前提,同一个路由路径可能有多种不同的请求方式,例如‘/api/books/’这个接口使用POST请求则对应添加一本新书的操作,而GET请求则表示请求所有书集合。
就我而言,我认为装饰器更能明显展示出参数和函数之间的关联例如:
@use_args({
"q": fields.Str(), # 模糊查询
"sort": fields.Str(missing='create_time')),
}, location='query')
def get(self, args: dict) -> None:
pass
@use_args({
'titile': fields.Str(required=True),
'writer': fields.Str(required=True),
'remark': fields.Str(required=True)
}, location='query')
def post(self, args: dict) -> None:
pass
而选择声明实例的方式容易使大量的参数堆在一起,但是可以通过变量名称来区分,对于新手来说可读性更强,所以各取所好。
2 对于某一个参数的取值限制
例如排序只可以对书名title,发布时间published_time这两个取值,可以用marshmallow.validate的OneOf的方法。
@use_args({
"q": fields.Str(), # 模糊查询
"sort": fields.Str(missing='create_time', validate=OneOf([
'title',
'published_time',
])),
}, location='query')
def get(self, args: dict) -> None:
pass
3 可以在接收路径参数的同时接收body参数
例如更新书本信息的方法
@route('/api/books/([0-9]+)')
class BookAPI(BaseHanlder):
def patch(self, id: int) -> None:
"""
更新书本新的接口
Args:
id:需要更新书本的id号
Returns:Json响应
"""
id = int(id)
args = json.loads(self.request.body)
flage = True
book = self.sess.query(Books).filter(Books.id == id)
if not book:
raise NotFoundError()
try:
book.update(args)
self.sess.commit()
except Exception as e:
flage = False
__import__('traceback').print_exc()
self.sess.rollback()
msg = f'更新任务{id}成功' if flage else f'更新任务{id}失败'
return self.write_json(data=None, msg=msg)
时尚的定义应该是敢于尝试新的事物