使用 Python 构建一个简单的 RESTful API
使用 Python 构建一个简单的 RESTful API
1. 简介
本文档旨在引导你使用 Python 构建一个简单的 RESTful API。我们将使用 Flask 框架,因为它轻量级且易于使用。我们将创建一个 API,它可以返回一个随机数和一个简单的“Hello World”消息。
2. 安装 Flask
首先,确保你已经安装了 Python。然后,使用 pip 安装 Flask:
pip install Flask
3. 创建 API 文件
创建一个名为 api.py
的文件,并添加以下代码:
from flask import Flask, jsonify
app = Flask(__name__)
@app.route('/')
def hello():
return jsonify({'message': 'Hello World!'})
@app.route('/random')
def random_number():
import random
return jsonify({'number': random.randint(1, 100)})
if __name__ == '__main__':
app.run(debug=True)
4. 代码解释
from flask import Flask, jsonify
: 导入 Flask 和 jsonify 模块。app = Flask(__name__)
: 创建一个 Flask 应用实例。@app.route('/')
: 定义一个路由,处理根路径的请求。def hello()
: 定义一个函数,返回一个包含消息的 JSON 对象。@app.route('/random')
: 定义另一个路由,处理/random
路径的请求。def random_number()
: 定义一个函数,生成一个随机数并返回包含该数字的 JSON 对象。if __name__ == '__main__':
: 确保代码只在直接运行文件时执行。app.run(debug=True)
: 启动 Flask 应用,并开启调试模式。
5. 运行 API
在命令行中运行以下命令:
python api.py
现在你就可以访问 API 了。
- 访问
http://127.0.0.1:5000/
会返回一个包含 "Hello World!" 消息的 JSON 对象。 - 访问
http://127.0.0.1:5000/random
会返回一个包含随机数的 JSON 对象。
6. 结论
在本文档中,你学习了如何使用 Python 和 Flask 构建一个简单的 RESTful API。你可以根据自己的需求扩展这个 API,添加更多的路由和功能。
注意:
- 为了安全起见,在生产环境中不要使用
debug=True
。 - 使用其他工具(如 Postman)可以方便地测试 API 请求。
- 你可以参考 Flask 文档 https://flask.palletsprojects.com/en/2.0.x/ 了解更多信息。
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· SQL Server 2025 AI相关能力初探
· AI编程工具终极对决:字节Trae VS Cursor,谁才是开发者新宠?
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南