Flask-RESTful 分析

news2024/11/24 11:03:35

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

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_id
    def get(self, todo_id):
        # 从todos字典中获取todo_id对应的待办事项，并返回
        # 如果todo_id不存在，会抛出一个KeyError异常
        return {todo_id: todos[todo_id]}
    # 定义PUT方法，当客户端发送PUT请求时会调用这个方法
    #(todo_id)表示这个方法是带参数的，参数名为todo_id
    def 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 OK
        return {'task': 'Hello world'}
# 定义一个名为Todo2的资源类，继承自flask_restful.Resource
class Todo2(Resource):
    # 定义GET方法，当客户端发送GET请求时会调用这个方法
    def get(self):
        # 返回一个字典{'task': 'Hello world'}，HTTP响应码设置为201 Created
        return {'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_id
        self.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 和 task
        return 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] = task
        return 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')) + 1
        todo_id = 'todo%i' % todo_id
        TODOS[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.coloradmin.cn/o/1561936.html

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

相关文章

无代理方式的网络准入技术：保护泛终端企业网络安全的未来

无代理方式的网络准入技术：保护泛终端企业网络安全的未来

云计算、大数据、物联网、移动化办公等技术的普及&#xff0c;打破了传统局域网的边界&#xff0c;通过各种方式连接到企业网络中的设备越来越多&#xff0c;如BYOD、IoT、OT等。企业在享受新技术带来的便利之际&#xff0c;也面临着更加多元化的安全威胁&#xff0c;如勒索病毒…
阅读更多...
vscode 自用的一些配置

vscode 自用的一些配置

目录 1&#xff0c;修改默认配置1&#xff0c;关闭预览模式2&#xff0c;取消自动定位到左侧边栏 2&#xff0c;自定义快捷键1&#xff0c;手动定位到左侧边栏2&#xff0c;关闭其他3&#xff0c;其他常用快捷键 3&#xff0c;插件1&#xff0c;和 git 相关的GitlensGit Histor…
阅读更多...
《2023腾讯云容器和函数计算技术实践精选集》--在 K8s 上跑腾讯云 Serverless 函数，打破传统方式造就新变革

《2023腾讯云容器和函数计算技术实践精选集》--在 K8s 上跑腾讯云 Serverless 函数，打破传统方式造就新变革

目录 目录 前言 《2023腾讯云容器和函数计算技术实践精选集》带来的思考 1、特色亮点 2、阅读体验 3、实用建议 4、整体评价 Serverless 和 K8s 的优势 1、关于Serverless 函数的特点 2、K8s 的特点 腾讯云 Serverless 函数在 K8s 上的应用对企业服务的影响 案例分…
阅读更多...
CrossOver玩游戏会损害电脑吗 CrossOver玩游戏会卡吗 Mac玩游戏 crossover24免费激活

CrossOver玩游戏会损害电脑吗 CrossOver玩游戏会卡吗 Mac玩游戏 crossover24免费激活

CrossOver是一款可以在macOS上运行Windows应用程序的软件&#xff0c;它利用了Wine技术&#xff0c;无需安装虚拟机或双系统&#xff0c;可以直接在苹果系统下运行Windows游戏。那么&#xff0c;使用CrossOver玩游戏会损害电脑吗&#xff1f;CrossOver玩游戏会卡吗&#xff1f;…
阅读更多...
设计模式23--观察者模式

设计模式23--观察者模式

定义 案例一 案例二 优缺点
阅读更多...
Java 操作 Hadoop 集群之 HDFS 的应用案例详解

Java 操作 Hadoop 集群之 HDFS 的应用案例详解

Java 操作 Hadoop 注意：本文内容基于 Hadoop 集群搭建完成基础上： Linux 系统 CentOS7 上搭建 Hadoop HDFS集群详细步骤 本文的内容是基于下面前提： Hadoop 集群搭建完成并能正常启动和访问Idea 和 Maven 分别安装完成需要有 JavaSE 基础和熟悉操作hadoop 的 hdfs dfs 命令…
阅读更多...
Samtec连接器 | 应用分享C-V2X技术在汽车领域的应用

Samtec连接器 | 应用分享C-V2X技术在汽车领域的应用

【前言】 在汽车设计领域有一个新的缩写&#xff0c;就是C-V2X。被谈及时&#xff0c;这被称为车辆到X&#xff0c;有时也被称为车辆到万物。前面的 "C "代表蜂窝网络。 这些缩写代表最新的基于车辆应用利用蜂窝通讯网络的电子产品。特别是&#xff0c;正在推出的5G…
阅读更多...
Spring6-单元测试：JUnit

Spring6-单元测试：JUnit

1. 概念 在进行单元测试时&#xff0c;特别是针对使用了Spring框架的应用程序&#xff0c;我们通常需要与Spring容器交互以获取被测试对象及其依赖。传统做法是在每个测试方法中手动创建Spring容器并从中获取所需的Bean。以下面的两行常见代码为例&#xff1a; ApplicationCo…
阅读更多...
AWS迁移教程，Redis迁移到Elasticache

AWS迁移教程，Redis迁移到Elasticache

当企业不断出海拓展业务&#xff0c;面临的挑战之一就是如何高效迁移应用程序及数据库至云端。为解决这一问题&#xff0c;AWS云专门提供多种简单且高效的迁移方式&#xff0c;进行帮助企业实现应用程序的平稳迁移&#xff0c;从而降低迁移过程中的风险和成本。下面九河云将为大…
阅读更多...
数据可视化基础与应用-07-数据可视化第二版各种类型图表的绘制优化版

数据可视化基础与应用-07-数据可视化第二版各种类型图表的绘制优化版

参考教材截图 数据可视化第二版-03部分-06章-比较与排序 总结 本系列博客为基于《数据可视化第二版》一书的教学资源博客。本文主要是第6章&#xff0c;比较与排序可视化的案例相关。 可视化视角-比较与排序 代码实现 创建虚拟环境 我的conda下有多个python环境。 1. pyt…
阅读更多...
云计算迎变局：阿里云、腾讯云“各有千秋”

云计算迎变局：阿里云、腾讯云“各有千秋”

毋庸置疑&#xff0c;无论在什么时候什么行业&#xff0c;低价策略都是一柄利器。比如&#xff0c;在电商行业&#xff0c;除了拼多多将低价策略贯彻到底之外&#xff0c;淘宝、京东也将性价比作为发力重点&#xff0c;并通过补贴、秒杀等方式&#xff0c;再度强调自身的“价格…
阅读更多...
微服务管理（完整）

微服务管理（完整）

前言&#xff1a; 分享一篇学微服务管理的过程 一&#xff0c;etcd入门 1&#xff0c;简介 1.1&#xff0c;etcd是什么 etcd是CoreOS团队于2013年6月发起的开源项目&#xff0c;它的目标是构建一个高可用的分布式键值(key-value)数据库。 官网上的一段描述&#xff1a; A…
阅读更多...
应用案例分享|3D视觉引导汽车铅蓄电池自动化拆垛

应用案例分享|3D视觉引导汽车铅蓄电池自动化拆垛

在汽车制造及相关配套产业链中&#xff0c;铅蓄电池作为关键零部件之一&#xff0c;其生产和处理环节对效率和精准度都有着极高的要求。传统的铅蓄电池拆垛作业往往依赖于人工操作&#xff0c;不仅效率低下&#xff0c;还存在安全隐患。 项目背景 某大型蓄电池企业&#xff0c…
阅读更多...
【JAVA】postman import certificates in project 导入证书pfx

【JAVA】postman import certificates in project 导入证书pfx

1. 打开这个按钮 2. File ->Settings 3. 打开“certificates”, Add certificates 添加证书 4. 输入证书地址&#xff0c;然后选择证书文件pfx , 输入证书密码。点击添加就可以了。 特别提醒&#xff1a; 推荐本地自己证书验证软件&#xff0c;“KeyStore” 这个软件可以…
阅读更多...
Coursera自然语言处理专项课程04：Natural Language Processing with Attention Models笔记 Week02

Coursera自然语言处理专项课程04：Natural Language Processing with Attention Models笔记 Week02

Natural Language Processing with Attention Models Course Certificate 本文是学习这门课 Natural Language Processing with Attention Models的学习笔记&#xff0c;如有侵权&#xff0c;请联系删除。 文章目录 Natural Language Processing with Attention ModelsText Su…
阅读更多...
VSCode 设置vue2模板

VSCode 设置vue2模板

点击设置 > 用户代码片段 > 输入Vue &#xff08;打开vue.json&#xff09;> 将代码复制内 "Print to console": {"prefix": "<","body": ["<template>"," <div class$1></div>"…
阅读更多...
GIS与数字孪生共舞，打造未来智慧场景

GIS与数字孪生共舞，打造未来智慧场景

作为一名数字孪生资深用户&#xff0c;近日我深刻理解到GIS&#xff08;地理信息系统&#xff09;在构建数字孪生体中的关键作用。 数字孪生技术旨在构建现实世界的虚拟镜像&#xff0c;而GIS则是这一镜像中不可或缺的空间维度框架和导航灯塔。数字孪生的核心是通过数字化方式…
阅读更多...
uni app 扫雷

uni app 扫雷

闲来无聊。做个扫雷玩玩吧&#xff0c;点击打开&#xff0c;长按标记&#xff0c;标记的点击两次或长按取消标记。所有打开结束 <template><view class"page_main"><view class"add_button" style"width: 100vw; margin-bottom: 20r…
阅读更多...
鸿蒙OS开发实例：【NAPI入门】

鸿蒙OS开发实例：【NAPI入门】

背景 公司内部已经有现成的MQTT动态库&#xff0c;想在HarmonyOS平台上共享使用。查找官方指导后&#xff0c;发现可以通过NAPI方式&#xff0c;将MQTT C库导入进来&#xff0c;然后封装一层ArkTS接口就可直接使用。 本篇内容是在按照官方指导下&#xff0c;自己做的一些调研…
阅读更多...
面对复杂多变的网络攻击，企业应如何守护网络安全

面对复杂多变的网络攻击，企业应如何守护网络安全

企业上云&#xff0c;即越来越多的企业把业务和数据&#xff0c;迁移到云端。随着云计算、大数据、物联网、人工智能等技术的发展&#xff0c;用户、应用程序和数据无处不在&#xff0c;企业之间的业务边界逐渐被打破&#xff0c;网络攻击愈演愈烈&#xff0c;手段更为多。 当前…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023