flask-restful使用总结

 更新时间:2018年12月04日 15:30:19   作者:stray  
Flask-RESTful是一个用于快速创建RESTful API接口的Flask扩展。,这篇文章主要介绍了flask-restful使用总结,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

Flask-RESTful是一个用于快速创建RESTful API接口的Flask扩展。使用Flask-RESTful可以很快速方便地创建一个RESTful风格的接口应用程序。

1、安装

pip install flask_restful

2、全部代码

from flask import Flask
from flask_restful import reqparse, abort, Api, Resource

app = Flask(__name__)
api = Api(app)

TODOS = {
  'todo1': {'task': 'build'},
  'todo2': {'task': 'bui2'},
  'todo3': {'task': 'bui3'}
}

parser = reqparse.RequestParser()
parser.add_argument('task')

class Todo(Resource):
  def get(self, todo_id):
    return TODOS[todo_id]

  def delete(self, todo_id):
    del TODOS[todo_id]
    return '', 204

  def put(self, todo_id):
    args = parser.parse_args()
    task = {'task': args['task']}
    TODOS[todo_id] = task
    return task, 201


class TodoList(Resource):
  def get(self):
    return TODOS


api.add_resource(TodoList, '/todos')
api.add_resource(Todo, '/todos/<todo_id>')

if __name__ == '__main__':
  app.run(debug=True)

3、代码说明

1). 初始化

在当前程序初始化一个flask-restful的api实例:

api = Api(app)

2). 定义资源类

资源类是restful接口的具体实现,需要继承Resource类。在类中可以定义get、post等符合restful规范的接口。

class Todo(Resource):
  def get(self, todo_id):
    return TODOS[todo_id]

  def delete(self, todo_id):
    del TODOS[todo_id]
    return '', 204

  def put(self, todo_id):
    args = parser.parse_args()
    task = {'task': args['task']}
    TODOS[todo_id] = task
    return task, 201

3). 参数解析

虽然 Flask 提供了简单的方法访问请求数据, 但是对于表单数据处理还是比较麻烦. Flask-RESTful 提供了 reqparse 一种类似 argparse 参数解析机制以简化参数处理.

parser = reqparse.RequestParser(): reqparse使用RequestParser() 可以从 flask.Request.values,以及 flask.Request.json 解析值。这里创建了一个解析对象parser。

parser.add_argument('task'):向parser对象中添加你要关注的命令行参数和选项,每一个add_argument方法对应一个你要关注的参数或选项。

parser.parse_args():调用parse_args()方法进行解析,解析成功之后即可使用。

4). add_argument扩展

对于必传的参数,可以设置required=True

parser.add_argument('name', type=str, required=True,
help="Name cannot be blank!")

传多个值,使用 action='append'

parser.add_argument('name', type=str, action='append')

使用:

curl http://api.example.com -d "Name=bob" -d "Name=sue" -d "Name=joe"

获取的参数为:

args = parser.parse_args()
args['name']  # ['bob', 'sue', 'joe']

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 基于Python的图像数据增强Data Augmentation解析

    基于Python的图像数据增强Data Augmentation解析

    这篇文章主要介绍了基于Python的图像数据增强Data Augmentation解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Python中map函数的技巧分享

    Python中map函数的技巧分享

    在Python中,map()是一个内置函数,这篇文章将从基础的使用方法到高级的技巧,全面介绍Python中map()方法的使用,感兴趣的小伙伴可以跟随小编一起学习一下
    2023-07-07
  • 深入解析Python中的__builtins__内建对象

    深入解析Python中的__builtins__内建对象

    __builtins__ 是内建模块__builtin__中的对象,使用Python中的内建函数时会通过__builtins__引导,这里我们就来深入解析Python中的__builtins__内建对象,需要的朋友可以参考下
    2016-06-06
  • 基于django ManyToMany 使用的注意事项详解

    基于django ManyToMany 使用的注意事项详解

    今天小编就为大家分享一篇基于django ManyToMany 使用的注意事项详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-08-08
  • Python基础常用内建函数图文示例解析

    Python基础常用内建函数图文示例解析

    这篇文章主要为大家Python常用内建函数,文中通过图例详细的给大家作出了讲解分析,有需要的朋友可以借鉴参考下,希望可以有所帮助
    2021-09-09
  • pytorch tensor计算三通道均值方式

    pytorch tensor计算三通道均值方式

    这篇文章主要介绍了pytorch tensor计算三通道均值方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-07-07
  • Django自定义插件实现网站登录验证码功能

    Django自定义插件实现网站登录验证码功能

    这篇文章主要为大家详细介绍了Django自定义插件实现网站登录验证码功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • Tornado Web Server框架编写简易Python服务器

    Tornado Web Server框架编写简易Python服务器

    这篇文章主要为大家详细介绍了Tornado Web Server框架编写简易Python服务器,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-07-07
  • 快速解决安装python没有scripts文件夹的问题

    快速解决安装python没有scripts文件夹的问题

    下面小编就为大家分享一篇快速解决安装python没有scripts文件夹的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-04-04
  • opencv 图像礼帽和图像黑帽的实现

    opencv 图像礼帽和图像黑帽的实现

    这篇文章主要介绍了opencv 图像礼帽和图像黑帽的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07

最新评论