使用Flask构建RESTful API

💓 博客主页:瑕疵的CSDN主页
📝 Gitee主页:瑕疵的gitee主页
⏩ 文章专栏:《热点资讯》

使用Flask构建RESTful API

      • Flask简介
      • 环境搭建
        • 安装Flask
      • 项目结构
      • 创建应用
      • 路由定义
      • 请求处理
        • 获取查询参数
        • 获取请求体
      • 响应格式化
        • JSON响应
      • 错误处理
      • 数据库集成
        • 安装SQLAlchemy
        • 配置数据库
        • 定义模型
        • 初始化数据库
      • 测试
      • 总结

Flask是一个轻量级的Web框架,适用于快速开发小型到中型的Web应用。本文将详细介绍如何使用Flask构建RESTful API,包括环境搭建、项目结构、路由定义、请求处理、响应格式化、错误处理、数据库集成、测试等内容。

Flask简介

Flask是一个用Python编写的轻量级Web应用框架。它没有固定的数据库抽象层、表单验证工具等,因此非常灵活,适合快速开发。

环境搭建

在开始之前,确保你的环境中已安装Python和pip。
安装Flask
pip install Flask

项目结构

一个典型的Flask项目结构如下:
my_flask_app/
├── app.py
├── config.py
├── models.py
├── routes.py
└── requirements.txt

创建应用

在`app.py`中创建Flask应用实例。
from flask import Flask, jsonify, requestapp = Flask(__name__)@app.route('/hello', methods=['GET'])
def hello():return jsonify({'message': 'Hello, World!'}), 200if __name__ == '__main__':app.run(debug=True)

路由定义

在`routes.py`中定义路由。
from flask import Blueprint, jsonify, requestapi_bp = Blueprint('api', __name__)@api_bp.route('/users', methods=['GET'])
def get_users():users = [{'id': 1, 'name': 'Alice'},{'id': 2, 'name': 'Bob'}]return jsonify(users), 200@api_bp.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):user = {'id': user_id, 'name': 'Unknown'}return jsonify(user), 200@api_bp.route('/users', methods=['POST'])
def create_user():data = request.jsonuser = {'id': 3, 'name': data['name']}return jsonify(user), 201# 导入蓝图
from app import app
app.register_blueprint(api_bp, url_prefix='/api')

请求处理

在Flask中,可以使用`request`对象来处理HTTP请求。
获取查询参数
@app.route('/search', methods=['GET'])
def search():query = request.args.get('q', '')results = []return jsonify(results), 200
获取请求体
@app.route('/submit', methods=['POST'])
def submit():data = request.jsonresult = process_data(data)return jsonify(result), 200

响应格式化

Flask提供了多种方式来格式化响应。
JSON响应
@app.route('/json', methods=['GET'])
def json_response():data = {'key': 'value'}return jsonify(data), 200

错误处理

可以使用`@app.errorhandler`装饰器来定义全局错误处理程序。
@app.errorhandler(404)
def not_found(error):return jsonify({'error': 'Not found'}), 404@app.errorhandler(500)
def internal_error(error):return jsonify({'error': 'Internal server error'}), 500

数据库集成

可以使用SQLAlchemy来集成数据库。
安装SQLAlchemy
pip install SQLAlchemy

配置数据库
config.py中配置数据库。

import osbasedir = os.path.abspath(os.path.dirname(__file__))SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'app.db')
SQLALCHEMY_TRACK_MODIFICATIONS = False

定义模型
models.py中定义数据库模型。

from flask_sqlalchemy import SQLAlchemy
from config import SQLALCHEMY_DATABASE_URIapp.config['SQLALCHEMY_DATABASE_URI'] = SQLALCHEMY_DATABASE_URI
db = SQLAlchemy(app)class User(db.Model):id = db.Column(db.Integer, primary_key=True)name = db.Column(db.String(64), index=True, unique=True)def to_dict(self):return {'id': self.id,'name': self.name}

初始化数据库
app.py中初始化数据库。

from models import dbdb.init_app(app)
with app.app_context():db.create_all()

测试

可以使用Flask的测试客户端来编写单元测试。

import unittest
from app import app累加器 = 0class TestApp(unittest.TestCase):def setUp(self):self.app = app.test_client()self.ctx = app.app_context()self.ctx.push()def tearDown(self):self.ctx.pop()def test_hello(self):response = self.app.get('/hello')self.assertEqual(response.status_code, 200)self.assertEqual(response.json, {'message': 'Hello, World!'})def test_get_users(self):response = self.app.get('/api/users')self.assertEqual(response.status_code, 200)self.assertEqual(len(response.json), 2)if __name__ == '__main__':unittest.main()

总结

通过本文,你已经学习了如何使用Flask构建RESTful API。我们介绍了Flask的基本概念、环境搭建、项目结构、路由定义、请求处理、响应格式化、错误处理、数据库集成、测试等内容。掌握了这些知识,将有助于你在实际工作中更好地利用Flask来构建高效、可靠的Web应用。
Flask项目结构示例

使用Flask可以快速构建灵活且高效的RESTful API。
Flask路由定义示例

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

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

相关文章

知识竞赛活动选手台桌怎么摆放好

知识竞赛活动选手台桌摆放主要根据选手台桌、舞台及和竞赛规则决定&#xff0c;一般有以下几种方案。 一、一字摆放 如果舞台宽度不够&#xff0c;就一字摆放。这样选手就无法看到大屏&#xff0c;选手就要配置看题平板或电脑。也可以在选手前面放置一台大电视。如图&#xf…

SQL之排名窗口函数RANK()、ROW_NUMBER()、DENSE_RANK() 和 NTILE() 的区别(SQL 和 Hive SQL 都支持)

现有一张student 表&#xff0c;表中包含id、uname、age、score 四个字段&#xff0c;如下所示&#xff1a; 该表的数据如下所示&#xff1a; 一、ROW_NUMBER() 1、概念 ROW_NUMBER() 为结果集中的每一行分配一个唯一的连续整数&#xff0c;编号从 1 开始。‌ 该函数按照指…

NeurIPS - Ariel Data Challenge 2024

1比赛概述 Ariel数据挑战2024 邀请参赛者开发机器学习模型&#xff0c;解决天文学领域中的一项重大挑战——从即将到来的欧洲航天局&#xff08;ESA&#xff09;Ariel任务的模拟观测中提取微弱的系外行星信号。Ariel任务计划于2029年启动&#xff0c;旨在对银河系邻近的约1,00…

Javaweb 实验4 xml

我发现了有些人喜欢静静看博客不聊天呐&#xff0c; 但是ta会点赞。 这样的人呢帅气低调有内涵&#xff0c; 美丽大方很优雅。 说的就是你&#xff0c; 不用再怀疑哦 实验四 XML 目的&#xff1a; 安装和使用XML的开发环境认识XML的不同类型掌握XML文档的基本语法了解D…

CRON组件一个复杂的一个简单的

CRON组件一个复杂的一个简单的 一个是复杂点的一个是简单点。 1.以简单的为例使用&#xff1a; 父组件 import CronSimple from "/views/xxx/components/cron-simple/index.vue";components: {CronSimple}<el-dialog title"调度CRON"v-if"cronV…

乒乓球烧拍日记之三蝴蝶蓝芳碳

朋友给了我个蝴蝶成品拍&#xff0c;要更换胶皮&#xff0c;底板是蓝芳碳磕碰很严重&#xff0c;木材都没了&#xff0c;没法补。淋巴面材&#xff0c;成品拍胶水很牢固非常难去除 把蓝芳碳纤维去除下毛边&#xff0c;然后用乳胶胶水填补缺失部分。(https://img-blog.csdnimg.…

高德地图如何标注店铺名称和位置信息?

在当今数字化和信息化的市场环境中&#xff0c;商家不仅需要提供优质的商品和服务&#xff0c;还需要通过多种方式来提升店铺的线上可见度和顾客体验。其中&#xff0c;在地图上准确标注店铺名称和位置信息已成为商家不可忽视的重要环节。而高德地图作为国内领先的导航和位置服…

构建品牌影响力:知识库工具在市场营销中的创新应用

在当今这个信息爆炸的时代&#xff0c;品牌影响力成为了企业市场竞争力的核心要素。为了有效提升品牌影响力&#xff0c;企业不仅需要精准的市场定位和优质的产品服务&#xff0c;还需要借助高效、智能的知识库工具来优化其市场营销策略。本文将探讨知识库工具在市场营销中的创…

HTML 文档规范与解析模式:DOCTYPE、<html> 标签以及结构化页面

文章目录 `<!DOCTYPE html>` 文档类型声明标准模式与怪异模式HTML5 的简化声明`<html>` 标签`<head>` 标签`<body>` 标签小结<!DOCTYPE html> 文档类型声明 在 HTML 文档中,<!DOCTYPE html> 是一个重要的文档类型声明,主要用于告知浏览…

YOLOv5之Common.py

文章目录 1.学习目的2.网络模型![在这里插入图片描述](https://i-blog.csdnimg.cn/direct/67b8dbd00c9b4034ba370fc8b8a6031a.jpeg)3.common.py分析 1.学习目的 YOLOv5中最关键一个模型类 2.网络模型 3.common.py分析 # Ultralytics YOLOv5 &#x1f680;, AGPL-3.0 license…

【设计模式】如何用C++实现依赖倒置

【设计模式】如何用C实现依赖倒置 一、什么是依赖倒置&#xff1f; 依赖倒置原则&#xff08;Dependency Inversion Principle&#xff0c;DIP&#xff09;是SOLID面向对象设计原则中的一项。它的核心思想是&#xff1a; 高层模块不应该依赖于低层模块&#xff0c;两者都应该…

2、liunx网络基础

一、TCP/IP协议概述 Linux服务器默认网卡配置文件在/etc/sysconfig/network-scripts/下&#xff0c;命名的名称一般为:ifcfg-eth0 ifcfg-eth1 &#xff0c;eth0表示第一块网卡&#xff0c;eth1表示第二块网卡&#xff0c;依次类推。一般DELL R720标配有4块千兆网卡。 TCP/IP&a…

MySQL的SQL语句之触发器的创建和应用

触发器 Trigger 一.触发器 作用&#xff1a;当检测到某种数据表发生数据变化时&#xff0c;自动执行操作&#xff0c;保证数据的完整性&#xff0c;保证数据的一致性。 1.创建一个触发器 如上图所示&#xff0c;查看这个create的帮助信息的时候&#xff0c;这个create trig…

2016年ATom-1活动期间航班的每10秒一次的碳 monoxide (CO) 观测数据

目录 简介 摘要 代码 引用 网址推荐 知识星球 机器学习 ATom: Observed and GEOS-5 Simulated CO Concentrations with Tagged Tracers for ATom-1 简介 该数据集包含2016年ATom-1活动期间航班的每10秒一次的碳 monoxide (CO) 观测数据&#xff0c;以及来自戈达德地球观…

Ambari里面添加hive组件

1.创建hive数据库 在添加hive组件之前需要做的事情&#xff0c;先在master这个虚拟机里面创建好hive 先进入虚拟机里面进入mysql 然后输入这个命令看看有没有自己创建的hive数据库 show databases;有的话会显示下面这个样子 没有的同学使用以下命令可以在MySQL中创建hive数…

Java 集合一口气讲完!(上)||o(*°▽°*)o|Ю [有人吗?]

Java 集合遍历 Java集合教程 - Java集合遍历 在Java Collections Framework中&#xff0c;不同类型的集合使用不同类型的数据结构以不同的方式存储它们的元素。 一些集合对它们的元素有排序&#xff0c;有些没有。集合框架提供了遍历集合的以下方法&#xff1a; 使用迭代器使…

Oracle视频基础1.1.3练习

1.1.3 需求&#xff1a; 完整格式查看所有用户进程里的oracle后台进程 查看物理网卡&#xff0c;虚拟网卡的ip地址 ps -ef | grep oracle /sbin/ifconfig要以完整格式查看所有用户进程中的 Oracle 后台进程&#xff0c;并查看物理和虚拟网卡的 IP 地址&#xff0c;可以使用以下…

akshare股票涨跌板与资金流向相关分析

## akshare文档涨跌板 https://akshare.akfamily.xyz/data/stock/stock.html#id374资金流向 https://akshare.akfamily.xyz/data/stock/stock.html#id154涨跌板&#xff1a;https://quote.eastmoney.com/ztb/detail#typeztgc 资金流向&#xff1a;https://data.eastmoney.com/…

11 P4995 跳跳!

题目&#xff1a; 核心&#xff1a; 贪心策略&#xff1a;每次都跳距离自己最远的石头 收获&#xff1a;双指针&#xff08;下标&#xff09;的使用 代码&#xff1a; #include<iostream> using namespace std; # define M 100 #include<algorithm> #include<ma…

热点聚焦:AI在医疗保健领域的深度渗透与变革

内容概要 随着人工智能技术的不断进步&#xff0c;我们正在见证一个充满奇迹的转变&#xff0c;尤其是在医疗保健领域。这种转变不仅仅涉及到提高效率&#xff0c;更在于重新定义我们对疾病诊断和治疗方案的理解。通过智能算法&#xff0c;AI能够在早期识别潜在的健康问题&…