首页
/ 正文

使用 Python 模块实现 REST API（建议收藏）

更新时间: 2025-04-14 01:39:26

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;演示链接： http://116.62.199.48:7070 ;

《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前，星球内专栏累计输出 90w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 3100+ 小伙伴加入学习，欢迎点击围观

前言

在数字化时代，应用程序之间的数据交互变得愈发重要。REST API（Representational State Transfer Application Programming Interface）作为构建可扩展、松耦合系统的基石，已成为开发者必备的技能之一。Python 凭借其简洁的语法和丰富的生态，提供了多种模块和框架，让开发者能够快速、高效地实现 REST API。本文将从零开始，逐步讲解如何使用 Python 模块搭建 REST API，涵盖基础概念、实战案例和进阶技巧，并附上代码示例，帮助读者掌握这一核心技能。

一、REST API 的核心概念与工作原理

1.1 什么是 REST API？

REST API 是一种基于 HTTP 协议的通信标准，它定义了客户端与服务器之间交互的规则。想象一个快递服务：快递员（客户端）通过电话（HTTP 请求）告知快递公司（服务器）需要寄送包裹（数据），而快递公司通过电话回复包裹的跟踪号（响应）。REST API 的核心在于通过标准的 HTTP 方法（如 GET、POST、PUT、DELETE）操作资源，并返回结构化的数据（如 JSON）。

1.2 REST API 的关键特性

无状态性：每次请求都独立，服务器不保存客户端状态。
统一接口：通过 HTTP 方法（GET、POST 等）和资源路径（如 /users）明确操作意图。
资源导向：所有操作都围绕资源（如用户、订单）展开。

1.3 HTTP 方法详解

方法	用途	类比场景
GET	获取资源数据	查看快递单状态
POST	创建新资源	寄送新包裹
PUT	更新资源（覆盖原有数据）	更换包裹的收件地址
DELETE	删除资源	取消订单
PATCH	部分更新资源	修改包裹的备注信息

二、Python 实现 REST API 的常用模块

2.1 Flask：轻量级框架的入门之选

Flask 是 Python 中最受欢迎的 Web 框架之一，因其简单易上手的特点，适合新手快速搭建 REST API。

2.1.1 核心代码示例：创建一个 Hello World API

from flask import Flask, jsonify  

app = Flask(__name__)  

@app.route('/api/hello', methods=['GET'])  
def hello_world():  
    return jsonify(message="Hello, REST API!")  

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

代码解释：

Flask 类创建应用实例。
@app.route 装饰器定义路由路径 /api/hello，并指定允许的 HTTP 方法 GET。
jsonify 将 Python 字典转换为 JSON 格式的响应。

2.2 FastAPI：现代 API 开发的高效选择

FastAPI 是基于 Python 3.7+ 的类型提示特性的高性能框架，它通过自动文档生成和类型校验，显著提升了开发效率。

2.2.2 FastAPI 实现 Hello World

from fastapi import FastAPI  

app = FastAPI()  

@app.get("/api/hello")  
def read_root():  
    return {"message": "Hello, FastAPI!"}

对比 Flask 的优势：

自动生成交互式文档（Swagger UI）。
类型注解简化数据校验，减少重复代码。

2.3 Django REST Framework：面向复杂项目的框架

Django REST Framework (DRF) 是 Django 的扩展库，适合需要 ORM、权限控制和序列化功能的大型项目。

2.3.3 DRF 的基础示例

from django.urls import path  
from rest_framework.urlpatterns import format_suffix_patterns  
from .views import UserList  

urlpatterns = [  
    path('api/users/', UserList.as_view(), name='user-list'),  
]  

urlpatterns = format_suffix_patterns(urlpatterns)

适用场景：

需要与数据库深度集成。
需要复杂的权限管理和认证（如 JWT）。

三、实战案例：构建图书管理系统 API

3.1 需求分析

假设我们需要实现一个简单的图书管理系统，支持以下功能：

获取所有书籍列表（GET /books）。
根据 ID 查询单本书（GET /books/{id}）。
添加新书籍（POST /books）。
更新书籍信息（PUT /books/{id}）。
删除书籍（DELETE /books/{id}）。

3.2 使用 Flask 实现

3.2.1 安装依赖

pip install flask

3.2.2 定义书籍数据与路由

from flask import Flask, jsonify, request  

app = Flask(__name__)  

books = [  
    {"id": 1, "title": "Python Crash Course", "author": "Eric Matthes"},  
    {"id": 2, "title": "REST API Design Rulebook", "author": "Mark Masse"}  
]  

@app.route('/api/books', methods=['GET'])  
def get_books():  
    return jsonify(books)  

@app.route('/api/books/<int:book_id>', methods=['GET'])  
def get_book(book_id):  
    book = next((b for b in books if b['id'] == book_id), None)  
    if book:  
        return jsonify(book)  
    return jsonify({"error": "Book not found"}), 404  

@app.route('/api/books', methods=['POST'])  
def create_book():  
    new_book = request.get_json()  
    books.append(new_book)  
    return jsonify(new_book), 201  

@app.route('/api/books/<int:book_id>', methods=['PUT'])  
def update_book(book_id):  
    data = request.get_json()  
    book = next((b for b in books if b['id'] == book_id), None)  
    if book:  
        book.update(data)  
        return jsonify(book)  
    return jsonify({"error": "Book not found"}), 404  

@app.route('/api/books/<int:book_id>', methods=['DELETE'])  
def delete_book(book_id):  
    global books  
    books = [b for b in books if b['id'] != book_id]  
    return jsonify({"message": "Book deleted"})  

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

3.2.3 测试 API

通过 curl 或 Postman 发送请求：

curl http://localhost:5000/api/books  

curl -X POST \  
  http://localhost:5000/api/books \  
  -H 'Content-Type: application/json' \  
  -d '{"id": 3, "title": "Clean Code", "author": "Robert C. Martin"}'

四、进阶技巧与最佳实践

4.1 数据验证与序列化

在实际开发中，数据验证至关重要。例如，使用 Pydantic（FastAPI 内置）或 Marshmallow（Flask/Django）确保输入符合预期格式。

4.1.1 FastAPI 中的 Pydantic 模型

from fastapi import FastAPI  
from pydantic import BaseModel  

app = FastAPI()  

class Book(BaseModel):  
    id: int  
    title: str  
    author: str  

@app.post("/api/books")  
def create_book(book: Book):  
    return book

4.2 身份验证与权限控制

对于需要保护的 API，可采用以下方案：

JWT（JSON Web Token）：通过加密令牌验证用户身份。
OAuth 2.0：适用于第三方服务集成。

4.2.2 使用 Flask-JWT-Extended 实现 JWT 认证

from flask_jwt_extended import JWTManager, create_access_token  

app = Flask(__name__)  
app.config["JWT_SECRET_KEY"] = "super-secret"  
jwt = JWTManager(app)  

@app.route("/login", methods=["POST"])  
def login():  
    username = request.json.get("username", None)  
    password = request.json.get("password", None)  
    if username != "admin" or password != "secret":  
        return jsonify({"msg": "Bad username or password"}), 401  
    access_token = create_access_token(identity=username)  
    return jsonify(access_token=access_token)

4.3 性能优化与部署

缓存机制：使用 Redis 或 Memcached 缓存高频请求结果。
异步处理：FastAPI 支持异步函数，适合高并发场景。
部署方案：使用 Gunicorn（WSGI）或 Uvicorn（ASGI）运行应用，并通过 Nginx 反向代理。

结论

通过本文的讲解，读者已经掌握了从零到一使用 Python 模块实现 REST API 的完整流程。无论是 Flask 的轻量级特性，还是 FastAPI 的高性能与易用性，开发者可以根据项目需求选择最适合的工具。随着实践的深入，建议进一步探索身份验证、数据库集成和自动化测试等高级主题，以构建健壮、可扩展的 API 系统。记住，REST API 的核心在于清晰的设计与标准化的通信协议——这正是 Python 模块能够高效支持的关键所在。

希望本文能成为您构建 REST API 的实用指南，也期待您在实际开发中不断探索与创新！

使用 Python 模块实现 REST API（建议收藏）

前言

一、REST API 的核心概念与工作原理

1.1 什么是 REST API？

1.2 REST API 的关键特性

1.3 HTTP 方法详解

二、Python 实现 REST API 的常用模块

2.1 Flask：轻量级框架的入门之选

2.1.1 核心代码示例：创建一个 Hello World API

2.2 FastAPI：现代 API 开发的高效选择

2.2.2 FastAPI 实现 Hello World

2.3 Django REST Framework：面向复杂项目的框架

2.3.3 DRF 的基础示例

三、实战案例：构建图书管理系统 API

3.1 需求分析

3.2 使用 Flask 实现

3.2.1 安装依赖

3.2.2 定义书籍数据与路由

3.2.3 测试 API

四、进阶技巧与最佳实践

4.1 数据验证与序列化

4.1.1 FastAPI 中的 Pydantic 模型

4.2 身份验证与权限控制

4.2.2 使用 Flask-JWT-Extended 实现 JWT 认证

4.3 性能优化与部署

结论

最新发布

DataGrip 2025.1 最新激活码，破解版安装教程（至2099年~）

Webstorm 2025.1 最新激活码，破解版安装教程（至2099年~）

Pycharm 2025.1 最新激活码，破解版安装教程（至2099年~）

IDEA 2025.1 最新激活码，破解版安装教程（至2099年~）

Cursor @ 符号（千字长文）

POP3 协议（一文讲透）

IMAP 协议（保姆级教程）

RDP 协议（建议收藏）

SFTP 协议（保姆级教程）

UDP 协议（长文解析）