Starlette如何实现简单的API网关

落宇同学_1118

落宇同学_1118

2026-11-19

868人浏览

原创

starlette 实现简单 api 网关的核心在于利用其 asgi 应用接口和中间件机制,通过自定义中间件拦截请求、转发至后端服务并返回响应。具体做法是定义一个继承自 starlette.middleware.base.basehttpmiddleware 的类,在 dispatch 方法中使用 httpx.asyncclient 发起异步代理请求,并将后端响应直接返回给客户端。这样做能确保网关具备非阻塞特性,同时支持动态路由或固定后端地址的配置。

Starlette如何实现简单的API网关

如何配置 Starlette 中间件以处理 HTTP 请求

要配置中间件,需实例化自定义的网关中间件类并将其添加到 Starlette 应用的 middleware 栈中。关键在于正确设置后端服务的 URL 前缀,并确保中间件能够捕获所有传入的请求上下文。通过这种方式,Starlette 会将请求传递给中间件链,最终由网关中间件执行转发逻辑。

Starlette如何实现简单的API网关

import asyncio
from starlette.applications import Starlette
from starlette.middleware import Middleware
from starlette.requests import Request
from starlette.responses import Response
import httpx

class GatewayMiddleware(BaseHTTPMiddleware):
    def __init__(self, app, backend_url: str):
        super().__init__(app)
        self.backend_url = backend_url.rstrip('/')
        self.client = httpx.AsyncClient(base_url=self.backend_url)

    async def dispatch(self, request: Request, call_next):
        # 构造目标 URL
        target_path = request.url.path
        query_params = str(request.url.query) if request.url.query else ''
        target_url = f"{self.backend_url}{target_path}{'?' + query_params if query_params else ''}"
        
        # 转发请求
        try:
            response = await self.client.request(
                method=request.method,
                url=target_url,
                headers=dict(request.headers),
                content=await request.body()
            )
            return Response(
                content=response.content,
                status_code=response.status_code,
                headers=dict(response.headers)
            )
        except httpx.RequestError as e:
            return Response(content=str(e), status_code=502)

app = Starlette(middleware=[Middleware(GatewayMiddleware, backend_url='http://localhost:8000')])

if __name__ == '__main__':
    import uvicorn
    uvicorn.run(app, host='0.0.0.0', port=8080)

预期结果:当向 http://localhost:8080/api/users 发送 GET 请求时,网关会将其转发至 http://localhost:8000/api/users,并将后端的响应状态码、头部和正文原样返回给客户端。如果后端不可达,则返回 502 Bad Gateway 错误。

如何处理请求头与异常转发

在处理请求头和异常时,必须注意 httpx 对某些特定头部(如 host、content-length)的处理规则,避免重复添加或冲突。同时,应捕获网络异常并转换为标准的 HTTP 错误响应,以保证网关的健壮性。通过检查 request.headers 并过滤掉不需要转发的头部,可以进一步优化转发行为。

Starlette 1.5.1
Starlette 1.5.1

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

下载

Starlette如何实现简单的API网关

# 修改后的 dispatch 方法片段
headers = {k: v for k, v in request.headers.items() if k.lower() not in ['host', 'connection']}
try:
    response = await self.client.request(
        method=request.method,
        url=target_url,
        headers=headers,
        content=await request.body()
    )
except httpx.ConnectError:
    return Response(content='Backend Unavailable', status_code=503)
except Exception:
    return Response(content='Internal Error', status_code=500)

预期结果:过滤掉 host 和 connection 头部后,转发请求更符合后端服务器的预期。若后端连接失败,返回 503 Service Unavailable;其他未知异常返回 500 Internal Server Error。

基于程序中某个输入、条件或结果的具体问题

当后端服务返回空响应体但状态码为 200 时,网关应如何正确处理?根据代码逻辑,response.content 将为空字节串,Response 对象会正常构建并返回空内容。这符合 HTTP 规范,无需特殊处理。但若后端返回非 JSON 格式且客户端期望 JSON,则需在网关层进行转换或报错,当前示例未包含此逻辑,保持透传行为。

大量免费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

679

12

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

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

2026.11.17

0

15

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

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

2026.11.17

0

15

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

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

2026.11.17

0

15

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

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

2026.11.17

0

10

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

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

2026.11.17

0

11

热门下载

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

精品课程

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