Starlette实现API版本控制

小枫大大_5501

小枫大大_5501

2026-11-20

573人浏览

原创

starlette 实现 api 版本控制的核心做法是自定义路由匹配逻辑,通过解析 url 路径中的版本号前缀(如 /v1/)或 http 请求头(如 accept-version),将请求动态分发到对应的处理函数。具体而言,可以继承 starlette.routing.route 或 apirouter 并重写 match 方法,在匹配阶段提取版本信息并注入到 scope 中,从而让后续中间件或视图函数能感知当前请求的 api 版本。

Starlette实现API版本控制

如何基于 URL 路径前缀区分 API 版本

基于 URL 路径前缀是最直观的版本控制方式,例如访问 /api/v1/users 和 /api/v2/users 分别调用不同版本的逻辑。实现时,可以在 Starlette 的路由表中注册带有正则表达式或路径参数的路由,并在路由匹配成功后,通过中间件或装饰器提取路径中的版本片段,将其存入 request.scope['api_version']。这样,业务逻辑层只需读取该字段即可决定执行哪套代码分支。

Starlette实现API版本控制

from starlette.applications import Starlette
from starlette.routing import Route, Match
from starlette.responses import JSONResponse
import re

class VersionedRoute(Route):
    def __init__(self, path, endpoint, name=None, methods=None):
        # 假设路径格式为 /api/v{version}/...
        # 这里简化处理,实际项目中建议使用更复杂的正则
        super().__init__(path, endpoint, name, methods)
        self.version_pattern = re.compile(r'/api/v(\d+)/')

    def match(self, scope):
        # 调用父类匹配获取基础结果
        match, child_scope = super().match(scope)
        if match == Match.FULL:
            # 从原始 path 中提取版本号
            version_match = self.version_pattern.search(scope['path'])
            if version_match:
                child_scope['api_version'] = int(version_match.group(1))
        return match, child_scope

async def get_users(request):
    version = request.scope.get('api_version', 1)
    data = {'users': ['Alice'], 'version': version}
    return JSONResponse(data)

app = Starlette(routes=[
    VersionedRoute('/api/v{version}/users', get_users),
])

上述代码定义了一个 VersionedRoute,它继承了 Starlette 的 Route 类。在 match 方法中,首先尝试匹配标准路由,如果匹配成功,则进一步从 scope['path'] 中利用正则表达式提取版本号,并将其写入 child_scope。这样,当请求 /api/v1/users 时,get_users 函数可以通过 request.scope['api_version'] 获取到版本号为 1。这种方式简单直接,适合版本迭代较少且结构清晰的场景。

如何通过中间件统一处理版本路由分发

除了修改路由类,使用中间件也是一种常见的版本控制策略。中间件可以在请求到达具体路由之前,对请求进行预处理。我们可以创建一个中间件,检查请求路径是否包含版本标识,如果有,则根据版本信息重新构造内部路由或直接调用对应的处理函数。这种方法的优势在于可以将版本逻辑与业务逻辑解耦,便于统一管理。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载

Starlette实现API版本控制

from starlette.middleware.base import BaseHTTPMiddleware
from starlette.responses import JSONResponse
from starlette.requests import Request

class VersionMiddleware(BaseHTTPMiddleware):
    async def dispatch(self, request: Request, call_next):
        path = request.url.path
        # 简单判断路径是否以 /api/v[0-9]+ 开头
        import re
        match = re.match(r'/api/v(\d+)', path)
        if match:
            version = int(match.group(1))
            request.scope['api_version'] = version
            # 可以在这里根据 version 做不同的处理
            # 例如:重写 path 去掉版本号部分,以便匹配内部无版本路由
            new_path = re.sub(r'/api/v\d+', '/api', path)
            request.scope['path'] = new_path
            request.scope['raw_path'] = new_path.encode('utf-8')
        
        response = await call_next(request)
        return response

# 在应用中使用
app.add_middleware(VersionMiddleware)

这段代码展示了一个名为 VersionMiddleware 的中间件。它在 dispatch 方法中拦截请求,使用正则表达式匹配路径中的版本号。如果匹配成功,它将版本号存入 request.scope,并将路径中的版本号部分移除,替换为统一的 /api 前缀。这样,后续的路由匹配就可以忽略版本号,只关注资源路径。这种方式的灵活性更高,可以轻松支持基于查询参数或 Header 的版本控制,只需修改匹配逻辑即可。

当请求路径中不包含版本号时会发生什么

如果请求路径中不包含版本号,例如直接访问 /api/users,在上述两种实现中会有不同的表现。在 VersionedRoute 方案中,由于正则表达式未匹配到版本号,api_version 不会被写入 scope,此时 get_users 函数中 request.scope.get('api_version', 1) 会返回默认值 1。而在 VersionMiddleware 方案中,由于正则匹配失败,中间件不会修改 scope 或 path,请求将继续按原路径匹配。如果存在对应的无版本路由,则会正常响应;否则可能返回 404 错误。因此,明确默认版本行为至关重要。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

796

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

699

12

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

20

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

20

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

20

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

20

10

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

2026.11.17

20

11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程