Flask-RESTful 分析

一只猴子在接线，背景是集成电路，整个场景采用了幽默卡通风格，色彩鲜艳

Flask-RESTful 是一个 Flask 扩展，它为构建 RESTful API 提供了方便的工具和资源。它简化了创建 RESTful 服务的过程，允许开发者专注于业务逻辑而不是 HTTP 协议的细节。

  1. 资源（Resources）：
    • Resource 类：是 Flask-RESTful 的核心，它代表一个 RESTful 资源。开发者可以通过继承 Resource 类并定义 HTTP 方法（如 get, post, put, delete 等）来创建资源。
    • 方法装饰器：可以使用 @marshal_with 装饰器来序列化输出数据，使用 @expect 装饰器来声明期望的输入数据。
  2. 字段（Fields）和_marshall_with：
    • 字段：是 Flask-RESTful 中的一个重要概念，用于定义如何将 Python 对象转换为 JSON。Field 类及其子类（如 StringField, IntegerField 等）用于描述和格式化输出。
    • marshal_with：是一个装饰器，用于指定一个字段列表（称为_marshallSchema），它定义了如何将资源方法返回的数据转换为 JSON。
  3. 请求解析（Request Parsing）：
    • Flask-RESTful 提供了请求解析功能，允许开发者定义输入数据的格式和类型。使用 reqparse.RequestParser 类，可以添加参数并指定参数类型、默认值、位置（如 JSON, 表单等）和其他验证器。
  4. API：
    • Api 类：是 Flask-RESTful 应用的入口点。它管理资源与 URL 的映射，并处理请求的分发。使用 Api 实例的 add_resource 方法可以将资源添加到应用中。
  5. 异常处理（Error Handling）：
    • Flask-RESTful 允许开发者定义自定义异常和错误处理逻辑。可以通过继承 restful.Api 类并重写 handle_error 方法来实现自定义错误处理。
  6. 认证（Authentication）：
    • Flask-RESTful 可以与 Flask 的认证扩展（如 Flask-Login）一起使用，以保护 API 并验证用户身份。
  7. API 版本控制：
    • Flask-RESTful 支持通过蓝图和子域来实现 API 的版本控制。
  8. 完整性和性能：
    • Flask-RESTful 提供了数据完整性的保证，确保客户端接收到的数据是完整和一致的。同时，它也考虑了性能优化，如使用缓存来提高响应速度。
      Flask-RESTful 的目标是提供一个简单的框架，让开发者能够以最少的工作量创建出符合 REST 架构风格的 Web 服务。通过利用 Flask 的简洁性和 Flask-RESTful 的强大功能，开发者可以快速构建出高效、可靠的 API。

最小API

# 导入 Flask 和 Flask-RESTful 的相关类
from flask import Flask
from flask_restful import Resource, Api
# 创建 Flask 应用实例
app = Flask(__name__)
# 创建 Flask-RESTful API 实例
api = Api(app)
# 定义一个名为 HelloWorld 的资源类，继承自 flask_restful.Resource
class HelloWorld(Resource):# 定义 GET 方法，当客户端发送 GET 请求时会调用这个方法def get(self):# 返回一个字典，其中包含一个键值对 'hello': 'world'return {'hello': 'world'}
# 将 HelloWorld 资源添加到 API 路由中，设置其 URL 为 '/'
api.add_resource(HelloWorld, '/')
# 当此脚本作为主程序运行时（而不是被导入时），执行以下代码
if __name__ == '__main__':# 启动 Flask 应用，开启 debug 模式以提供调试信息app.run(debug=True)

这段代码创建了一个基本的 Flask 应用，并使用 Flask-RESTful 扩展添加了一个简单的 RESTful API。当你在浏览器或使用工具（如 curl）访问服务器的根 URL（http://localhost:5000/）时，你会得到一个 JSON 响应 {"hello": "world"}。

与资源交互

这段代码创建了一个简单的待办事项（Todo）管理应用，允许用户通过HTTP GET和PUT请求来检索和更新待办事项。

# 导入Flask和Flask-RESTful的相关类
from flask import Flask, request
from flask_restful import Resource, Api
# 创建Flask应用实例
app = Flask(__name__)
# 创建Flask-RESTful API实例
api = Api(app)
# 创建一个字典来存储待办事项，键为todo_id，值为待办事项的内容
todos = {}
# 定义一个名为TodoSimple的资源类，继承自flask_restful.Resource
class TodoSimple(Resource):# 定义GET方法，当客户端发送GET请求时会调用这个方法#(todo_id)表示这个方法是带参数的，参数名为todo_iddef get(self, todo_id):# 从todos字典中获取todo_id对应的待办事项，并返回# 如果todo_id不存在，会抛出一个KeyError异常return {todo_id: todos[todo_id]}# 定义PUT方法，当客户端发送PUT请求时会调用这个方法#(todo_id)表示这个方法是带参数的，参数名为todo_iddef put(self, todo_id):# 从请求的表单数据中获取'data'字段，并将其存储在todos字典中# todo_id作为键，request.form['data']作为值todos[todo_id] = request.form['data']# 返回更新后的待办事项return {todo_id: todos[todo_id]}
# 将TodoSimple资源添加到API路由中，设置其URL为'/<string:todo_id>'
# 这里的<string:todo_id>表示todo_id是一个字符串类型的参数
api.add_resource(TodoSimple, '/<string:todo_id>')
# 当此脚本作为主程序运行时（而不是被导入时），执行以下代码
if __name__ == '__main__':# 启动Flask应用，开启debug模式以提供调试信息app.run(debug=True)

这段代码定义了一个名为 TodoSimple 的资源，它有两个方法：get 和 put。get 方法用于检索指定 todo_id 的待办事项，而 put 方法用于创建或更新待办事项的内容。待办事项的数据存储在全局字典 todos 中。应用运行后，可以通过发送 HTTP 请求到 /todo_id 来与资源进行交互。

定义响应头

这段代码定义了三个Flask-RESTful资源类，每个类都只有一个GET方法，但它们在返回响应时有所不同。

# 导入Flask-RESTful的Resource类
from flask_restful import Resource
# 定义一个名为Todo1的资源类，继承自flask_restful.Resource
class Todo1(Resource):# 定义GET方法，当客户端发送GET请求时会调用这个方法def get(self):# 返回一个字典{'task': 'Hello world'}，HTTP响应码默认为200 OKreturn {'task': 'Hello world'}
# 定义一个名为Todo2的资源类，继承自flask_restful.Resource
class Todo2(Resource):# 定义GET方法，当客户端发送GET请求时会调用这个方法def get(self):# 返回一个字典{'task': 'Hello world'}，HTTP响应码设置为201 Createdreturn {'task': 'Hello world'}, 201
# 定义一个名为Todo3的资源类，继承自flask_restful.Resource
class Todo3(Resource):# 定义GET方法，当客户端发送GET请求时会调用这个方法def get(self):# 返回一个字典{'task': 'Hello world'}，HTTP响应码设置为201 Created# 并添加自定义响应头{'Etag': 'some-opaque-string'}return {'task': 'Hello world'}, 201, {'Etag': 'some-opaque-string'}

在这个例子中，每个类都代表一个可以访问的资源。Todo1 返回一个默认的200响应码，表示请求成功。Todo2 返回一个201响应码，通常用于创建资源的响应，表示请求已成功处理并创建了新的资源。Todo3 也返回一个201响应码，但同时还包括了一个自定义的响应头Etag，这通常用于缓存验证，表示资源的版本信息。
这些类可以添加到Flask-RESTful的API中，并通过相应的URL路径进行访问。每个类的get方法都可以通过HTTP GET请求来调用，返回一个 JSON 响应 {"hello": "world"}。

参数验证

这段代码使用了 Flask-RESTful 的 reqparse 模块来解析请求参数。

# 导入 Flask-RESTful 的 reqparse 模块
from flask_restful import reqparse
# 创建一个 RequestParser 实例，用于解析请求中的参数
parser = reqparse.RequestParser()
# 使用 add_argument 方法添加一个参数 'rate' 到解析器中
# 参数类型设置为 int，表示期望 'rate' 是一个整数
# help='Rate to charge for this resource' 提供了一个帮助信息，当参数验证失败时会显示这个信息
parser.add_argument('rate', type=int, help='Rate to charge for this resource')
# 调用 parse_args 方法来解析请求中的参数
# 如果请求中包含 'rate' 参数，它会将其转换为整数，并存储在 args 对象中
# 如果 'rate' 参数不存在或者不是整数，Flask-RESTful 会返回一个 400 Bad Request 响应，并显示帮助信息
args = parser.parse_args()
# 现在 args 对象包含了请求中的 'rate' 参数，可以直接使用 args['rate'] 来获取其值

# 调用 parse_args 方法来解析请求中的参数
# strict=True 参数指定了严格模式，只有预先在解析器中定义的参数会被接受
# 如果请求中包含未定义的参数，将抛出一个 BadRequest 异常，导致 400 Bad Request 响应
args = parser.parse_args(strict=True)

在这个例子中，parser 对象被用来定义期望从请求中解析出的参数。add_argument 方法用于指定参数的名称、类型和帮助信息。当 parse_args 方法被调用时，它会解析实际的请求，提取出 rate 参数，并将其转换为整数类型。如果解析过程中出现问题（例如，rate 参数不是整数），Flask-RESTful 会自动生成一个错误响应。

格式化数据

这段代码展示了如何使用 Flask-RESTful 的 marshal_with 装饰器和 fields 模块来格式化资源类的输出。

# 导入 Flask-RESTful 的 fields 和 marshal_with
from flask_restful import fields, marshal_with
# 定义一个字段映射，指定了资源返回的数据结构
# 'task' 字段将被格式化为字符串，'uri' 字段将被格式化为 URL
# 'uri' 字段的值 'todo_ep' 是一个 endpoint 名称，用于生成 URL
resource_fields = {'task':   fields.String,'uri':    fields.Url('todo_ep')
}
# 定义一个 TodoDao 类，代表待办事项的数据访问对象
class TodoDao(object):def __init__(self, todo_id, task):self.todo_id = todo_idself.task = task# 定义一个 'status' 属性，但注释指出这个字段不会包含在响应中self.status = 'active'
# 定义一个 Todo 资源类，继承自 flask_restful.Resource
class Todo(Resource):# 使用 marshal_with 装饰器，指定了返回值应该使用 resource_fields 来格式化@marshal_with(resource_fields)def get(self, **kwargs):# 创建一个 TodoDao 实例，并传入 todo_id 和 taskreturn TodoDao(todo_id='my_todo', task='Remember the milk')

在这个例子中，marshal_with 装饰器用于指定返回值的格式。resource_fields 字典定义了哪些字段应该包含在响应中，以及它们应该如何被格式化。fields.String 表示该字段应该被格式化为字符串，而 fields.Url 表示该字段应该被格式化为 URL，todo_ep 是一个 endpoint 名称，它将被用于生成实际的 URL。
TodoDao 类是一个简单的数据访问对象，它包含了 todo_id、task 和 status 属性。在 Todo 资源类的 get 方法中，创建了一个 TodoDao 实例，并返回它。由于 marshal_with 装饰器的使用，只有 task 和 uri 字段会被包含在最终的响应中，而 status 字段会被忽略。

完整示例

# 导入 Flask 和 Flask-RESTful 的相关类
from flask import Flask
from flask_restful import reqparse, abort, Api, Resource
# 创建 Flask 应用实例
app = Flask(__name__)
# 创建 Flask-RESTful API 实例
api = Api(app)
# 定义一个字典来存储待办事项，键为 todo_id，值为待办事项的内容
TODOS = {'todo1': {'task': 'build an API'},'todo2': {'task': '?????'},'todo3': {'task': 'profit!'},
}
# 定义一个函数来检查待办事项是否存在，如果不存在则抛出 404 错误
def abort_if_todo_doesnt_exist(todo_id):if todo_id not in TODOS:abort(404, message="Todo {} doesn't exist".format(todo_id))
# 创建一个 RequestParser 实例来解析请求中的参数
parser = reqparse.RequestParser()
parser.add_argument('task')
# 定义一个 Todo 资源类，继承自 flask_restful.Resource
class Todo(Resource):# 定义 GET 方法，用于获取指定 todo_id 的待办事项def get(self, todo_id):abort_if_todo_doesnt_exist(todo_id)return TODOS[todo_id]# 定义 DELETE 方法，用于删除指定 todo_id 的待办事项def delete(self, todo_id):abort_if_todo_doesnt_exist(todo_id)del TODOS[todo_id]return '', 204  # 返回空响应和 204 No Content 状态码# 定义 PUT 方法，用于更新指定 todo_id 的待办事项def put(self, todo_id):args = parser.parse_args()task = {'task': args['task']}TODOS[todo_id] = taskreturn task, 201  # 返回更新后的待办事项和 201 Created 状态码
# 定义一个 TodoList 资源类，继承自 flask_restful.Resource
class TodoList(Resource):# 定义 GET 方法，用于获取所有待办事项的列表def get(self):return TODOS# 定义 POST 方法，用于添加新的待办事项def post(self):args = parser.parse_args()todo_id = int(max(TODOS.keys()).lstrip('todo')) + 1todo_id = 'todo%i' % todo_idTODOS[todo_id] = {'task': args['task']}return TODOS[todo_id], 201  # 返回新添加的待办事项和 201 Created 状态码
# 添加资源路由到 API
api.add_resource(TodoList, '/todos')  # 将 TodoList 资源映射到 /todos 路径
api.add_resource(Todo, '/todos/<todo_id>')  # 将 Todo 资源映射到 /todos/<todo_id> 路径
# 当此脚本作为主程序运行时，执行以下代码
if __name__ == '__main__':# 启动 Flask 应用，开启 debug 模式以提供调试信息app.run(debug=True)

这个应用定义了两个资源：Todo 和 TodoList。Todo 资源允许用户获取、删除和更新特定的待办事项，而 TodoList 资源允许用户获取所有待办事项的列表和添加新的待办事项。待办事项的数据存储在全局字典 TODOS 中。应用运行后，可以通过发送 HTTP 请求到指定的 URL 来与资源进行交互。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/794100.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

Java集合详解（一）-- List集合

Java集合详解（一）-- List集合

1.集合简介 java集合可分为Set、List、Queue和Map四种体系。 Java集合就像一种容器&#xff0c;可以把多个对象&#xff08;实际上是对象的引用&#xff0c;但习惯上都称对象&#xff09;“丢进”该容器中。从Java 5 增加了泛型以后&#xff0c;Java集合可以记住容器中对象的数…
阅读更多...
PW1503限流芯片：可达3A限流，保障USB电源管理安全高效

PW1503限流芯片：可达3A限流，保障USB电源管理安全高效

在电源管理领域&#xff0c;开关的性能直接关系到设备的稳定性和安全性。今天&#xff0c;我们将详细解析一款备受关注的超低RDS&#xff08;ON&#xff09;开关——PW1503。它不仅具有可编程的电流限制功能&#xff0c;还集成了多项保护机制&#xff0c;为各类电子设备提供了高…
阅读更多...
解决在统信UOS Linux下缺乏zlib和jpeg库导致的安装Pillow报错问题

解决在统信UOS Linux下缺乏zlib和jpeg库导致的安装Pillow报错问题

☞ ░ 前往老猿Python博客 ░ https://blog.csdn.net/LaoYuanPython 一、引言 今天在统信UOS Linux的Python3环境下安装Pillow遇到了问题&#xff0c;导致安装不成功&#xff0c;通过报错信息。 二、第一执行pip3 install pillow安装报错 为了提高效率&#xff0c;指向了清华…
阅读更多...
Spring重点知识（个人整理笔记）

Spring重点知识（个人整理笔记）

目录 1. 为什么要使用 spring&#xff1f; 2. 解释一下什么是 Aop&#xff1f; 3. AOP有哪些实现方式&#xff1f; 4. Spring AOP的实现原理 5. JDK动态代理和CGLIB动态代理的区别&#xff1f; 6. 解释一下什么是 ioc&#xff1f; 7. spring 有哪些主要模块&#xff1f;…
阅读更多...
Spring-IoC 基于注解

Spring-IoC 基于注解

基于xml方法见&#xff1a;http://t.csdnimg.cn/dir8j 注解是代码中的一种特殊标记&#xff0c;可以在编译、类加载和运行时被读取&#xff0c;执行相应的处理&#xff0c;简化 Spring的 XML配置。 格式&#xff1a;注解(属性1"属性值1",...) 可以加在类上…
阅读更多...
计算机网络-HTTP相关知识-基础

计算机网络-HTTP相关知识-基础

HTTP基础 基本概念&#xff1a;HTTP是一种计算机之间交流通信的规范&#xff0c;它允许数据在两点之间传输&#xff0c;这个过程可以包括中转或接力。HTTP不仅仅包括文本&#xff0c;还可以包括图片、音频等超文本。状态码&#xff1a;HTTP状态码分为五类&#xff1a; 2xx&…
阅读更多...
一文搞懂 ThreadLocal

一文搞懂 ThreadLocal

简介 ThreadLocal存取的数据&#xff0c;总是与当前线程相关&#xff0c;也就是说&#xff0c;JVM 为每个运行的线程&#xff0c;绑定了私有的本地实例存取空间&#xff0c;从而为多线程环境常出现的并发访问问题提供了一种隔离机制。 ThreadLocal的作用是提供线程内的局部变…
阅读更多...
RK3588 NPU 研究（二）

RK3588 NPU 研究（二）

RK提供了两个模型&#xff0c;mobilenet和YOLO5。 mobilenet模型相对小&#xff0c;使用起来不是很明显yolo5模型大一些&#xff0c;可以对88种目标进行检测&#xff0c;提供检测的结果包括类别、包围框坐标、可信度等信息。基于rknn_yolov5_demo进行分析。 rknn_yolov5_demo基…
阅读更多...
TIMO后台管理系统-入门，简单易懂教程-技巧总结

TIMO后台管理系统-入门，简单易懂教程-技巧总结

Timo 要说的话&#xff1a; 这个项目的技术栈是JPA&#xff0c;会有很多文件去追踪&#xff0c;这些文件大多是使用内部的代码生成器做的&#xff0c;API文档做得不错&#xff0c;之前没做过项目的同学花一天了解API文件还是不错的 资料&#xff1a; 文档&#xff1a;http:…
阅读更多...
360手机位置穿越修复 360手机位置穿越 360手机刷机 360手机黑科技 360位置穿越下载

360手机位置穿越修复 360手机位置穿越 360手机刷机 360手机黑科技 360位置穿越下载

360手机位置穿越修复 360手机位置穿越 360手机刷机 360手机黑科技 360位置穿越下载 360手机位置穿越钉钉打卡 360手机位置穿越微信打卡 360手机位置穿越滴滴打卡 360手机位置穿越美团打卡 360手机位置穿越 360手机位置穿越下载 360手机位置穿越 支持钉钉、微信等位置修改…
阅读更多...
若依自带vue-cropper上传图片（可旋转、缩放）

若依自带vue-cropper上传图片（可旋转、缩放）

2024.4.4今天我学习了如何使用若依的vue-cropper上传图片组件&#xff0c;在工作中遇到一个需求&#xff0c;需要对上传的图片进行旋转的操作&#xff0c;然后我先找到el-upload组件&#xff0c;使用之后发现它有一个自动上传和非自动上传的功能&#xff0c;是不是就可以通过非…
阅读更多...
vulhub中Struts2-001 远程代码执行漏洞复现

vulhub中Struts2-001 远程代码执行漏洞复现

该漏洞因为用户提交表单数据并且验证失败时&#xff0c;后端会将用户之前提交的参数值使用 OGNL 表达式 %{value} 进行解析&#xff0c;然后重新填充到对应的表单数据中。例如注册或登录页面&#xff0c;提交失败后端一般会默认返回之前提交的数据&#xff0c;由于后端使用 %{v…
阅读更多...
【快速解决】python缺少了PyQt5模块的QtMultimedia子模块

【快速解决】python缺少了PyQt5模块的QtMultimedia子模块

目录 问题描述 问题原因 解决方法 成功示范 问题描述 Traceback (most recent call last): File "d:\桌面\python项目\DesktopWords-master\main.py", line 4, in <module> from PyQt5.QtMultimedia import QMediaPlayer, QMediaContent ModuleNotFoundEr…
阅读更多...
设计模式总结-工厂方法模式

设计模式总结-工厂方法模式

工厂方法模式 简单工厂模式的不足模式动机模式定义模式结构模式分析模式实例与解析 简单工厂模式的不足 在简单工厂模式中&#xff0c;只提供了一个工厂类&#xff0c;该工厂类处于对产品类进行实例化的中心位置&#xff0c;它知道每一个产品对象的创建细节&#xff0c;并决定…
阅读更多...
Windows集群部署项目

Windows集群部署项目

目录 一&#xff0c;环境准备 1.1.安装MySQL 1.2.安装JDK 1.3.安装TomCat 1.4.安装Nginx 二&#xff0c;部署 2.1.后台服务部署 2.2.Nginx配置负载均衡及静态资源部署 一&#xff0c;环境准备 1.1.安装MySQL 可以参考博客&#xff1a;http://t.csdnimg.cn/A75bg 1.2.…
阅读更多...
RP2040开发笔记

RP2040开发笔记

RP2040 采用合宙的RP2040(板载4MB Flash)&#xff0c; 所有开发资料参考官方&#xff1a;树莓派 Pico 中文站
阅读更多...
2024整理一些前端面试题库一

2024整理一些前端面试题库一

以下是一些2024年前端面试题及其答案&#xff1a; HTML、XML、XHTML之间的区别是什么&#xff1f; HTML是一种标记语言&#xff0c;用于创建网页&#xff0c;定义页面的结构和内容&#xff0c;如标题、段落、表格、链接、图片等。 XML&#xff08;可扩展标记语言&#xff09;…
阅读更多...
【活动创作】未来AI技术方面会有哪些创业机会

【活动创作】未来AI技术方面会有哪些创业机会

放假期间突然看到这个活动创作&#xff0c;觉得很有意思&#xff0c;既然如此&#xff0c;我就先让AI来回答一下吧&#xff0c;哈哈 1、文心一言 首先来看看文心一言的回答&#xff1a; 2、讯飞星火 然后来看看讯飞星火的回答&#xff1a; 3、个人感受 最后来说说给人感受吧&am…
阅读更多...
查看MySQL版本的方式

查看MySQL版本的方式

文章目录 一、使用cmd输入命令行查看二、在mysql客户端服务器里查询 一、使用cmd输入命令行查看 1、打开 cmd &#xff0c;输入命令行&#xff1a; mysql --version 2、还是打开cmd&#xff0c;输入命令行&#xff1a;mysql -V (注意了&#xff0c;此时的V是个大写的V) 二、…
阅读更多...
Linux课程____LVM（逻辑卷管理器）

Linux课程____LVM（逻辑卷管理器）

LVM 技术是在硬盘分区和文件系统之间添加了一个逻辑层&#xff0c;它提供了一个抽象的卷组&#xff0c;可以把多块硬盘进行卷组合并。 这样一来&#xff0c;用户不必关心物理硬盘设备的底层架构和布局&#xff0c;就可以实现对硬盘分区的动态调整。 动态调整磁盘容量&#xff…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023