使用 Python 和 Flask 构建 RESTful API

简介: 【10月更文挑战第2天】使用 Python 和 Flask 构建 RESTful API

引言

随着 Web 应用程序的发展,API(应用程序编程接口)变得越来越重要。RESTful API 是一种基于 HTTP 协议的标准设计模式,允许开发者以一种统一的方式访问和操作数据。今天,我们将使用 Python 和 Flask 框架来创建一个简单的 RESTful API。

准备工作

首先,确保你的环境中已安装 Python。接下来,你需要安装 Flask。可以通过 pip 安装 Flask:

pip install flask

创建项目结构

我们将在当前目录下创建一个简单的文件结构:

myapi/
    ├── app.py
    └── requirements.txt

requirements.txt 文件中列出所有需要的包:

Flask==2.0.1

确保安装了所需的依赖项:

pip install -r requirements.txt

编写代码

打开 app.py 文件,并添加以下代码来创建一个简单的 Flask 应用:

from flask import Flask, jsonify, request

app = Flask(__name__)

# 示例数据存储
data_store = [
    {
   'id': 1, 'name': 'Alice', 'email': 'alice@example.com'},
    {
   'id': 2, 'name': 'Bob', 'email': 'bob@example.com'}
]

@app.route('/users', methods=['GET'])
def get_users():
    return jsonify(data_store)

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    user = next((item for item in data_store if item['id'] == user_id), None)
    if user:
        return jsonify(user)
    else:
        return jsonify({
   'error': 'User not found'}), 404

@app.route('/users', methods=['POST'])
def create_user():
    new_user = request.get_json()
    new_user['id'] = max(item['id'] for item in data_store) + 1
    data_store.append(new_user)
    return jsonify(new_user), 201

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

上述代码定义了一个简单的 RESTful API,包括 GET 请求获取用户列表或单个用户的信息,以及 POST 请求来创建新用户。

运行应用

保存文件后,在命令行工具中切换到 myapi/ 目录,并运行以下命令来启动 Flask 应用:

python app.py

此时,应用应该在本地运行,并监听于 http://127.0.0.1:5000/

测试 API

你可以使用工具如 Postman 或 curl 来测试 API:

  • 获取所有用户:GET http://127.0.0.1:5000/users
  • 获取特定用户:GET http://127.0.0.1:5000/users/1
  • 创建新用户:POST http://127.0.0.1:5000/users 并附带 JSON 格式的数据,例如 {"name": "Charlie", "email": "charlie@example.com"}

结论

在这个简单的示例中,我们展示了如何使用 Flask 创建 RESTful API。尽管这是一个非常基础的例子,但它为构建更复杂的 API 提供了一个良好的起点。随着功能的增加,可能还需要考虑认证、授权等更高级的主题。

目录
相关文章
|
6天前
|
JSON API 数据安全/隐私保护
Python采集淘宝评论API接口及JSON数据返回全流程指南
Python采集淘宝评论API接口及JSON数据返回全流程指南
|
9天前
|
缓存 监控 供应链
唯品会自定义 API 自定义操作深度分析及 Python 实现
唯品会开放平台提供丰富API,支持商品查询、订单管理、促销活动等电商全流程操作。基于OAuth 2.0认证机制,具备安全稳定的特点。通过组合调用基础接口,可实现数据聚合、流程自动化、监控预警及跨平台集成,广泛应用于供应链管理、数据分析和智能采购等领域。结合Python实现方案,可高效完成商品搜索、订单分析、库存监控等功能,提升电商运营效率。
|
9天前
|
缓存 监控 供应链
京东自定义 API 操作深度分析及 Python 实现
京东开放平台提供丰富API接口,支持商品、订单、库存等电商全链路场景。通过自定义API组合调用,可实现店铺管理、数据分析、竞品监控等功能,提升运营效率。本文详解其架构、Python实现与应用策略。
JSON 监控 API
26 0
|
30天前
|
JSON 供应链 API
京东工业商品详情API数据python解析
京东工业商品详情API专为工业品采购设计,提供商品参数、资质认证、供应链等专业数据,适用于企业采购与供应链管理。支持多SKU查询,采用HTTPS协议与JSON格式,保障数据安全与高效调用。附Python调用示例,便于快速集成。
|
8月前
|
安全 前端开发 数据库
Python 语言结合 Flask 框架来实现一个基础的代购商品管理、用户下单等功能的简易系统
这是一个使用 Python 和 Flask 框架实现的简易代购系统示例,涵盖商品管理、用户注册登录、订单创建及查看等功能。通过 SQLAlchemy 进行数据库操作,支持添加商品、展示详情、库存管理等。用户可注册登录并下单,系统会检查库存并记录订单。此代码仅为参考,实际应用需进一步完善,如增强安全性、集成支付接口、优化界面等。
|
11月前
|
JSON 测试技术 数据库
Python的Flask框架
【10月更文挑战第4天】Python的Flask框架
134 1
|
11月前
|
存储 SQL 数据库
使用Python和Flask框架创建Web应用
【10月更文挑战第3天】使用Python和Flask框架创建Web应用
123 1
|
12月前
|
JSON 测试技术 数据库
Python的Flask框架
Python的Flask框架
|
JSON 测试技术 数据库
Python的Flask框架
Python的Flask框架

热门文章

最新文章

推荐镜像

更多