讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

AniShort
AniShort

AI短剧协同制作平台

fastapi 如何实现简单的 API Key 认证(Header)

小涛吖_6261

小涛吖_6261

发布时间:2026-01-28 14:15:10

|

301人浏览过

|

来源于php中文网

原创

推荐用HTTPBearer提取Bearer格式API Key,若用X-API-Key等自定义Header则须手写依赖函数;HTTPBearer仅提取不校验,校验需自行实现,且注意反向代理透传和Header大小写问题。

fastapi 如何实现简单的 api key 认证(header)

FastAPI 中用 HTTPBearer 提取 API Key 最直接

不推荐手写依赖去解析 Authorization Header,FastAPI 官方的 HTTPBearer 已经封装好标准流程:自动检查 Header 是否存在、是否以 "Bearer " 开头、提取 token 字符串。它本质是帮你省掉字符串切分和空值判断这类重复逻辑。

关键点:

  • HTTPBearer 默认要求 Header 是 Authorization: Bearer xxx 格式,不是 API-Key 或其他自定义 key —— 如果你已有客户端固定发 X-API-Key,得换方案
  • 它只做提取,不做校验;后续需自行比对密钥是否合法
  • 若想支持 API-Key: xxx 这类非 Bearer 格式,必须自己写依赖函数,不能复用 HTTPBearer

自定义 Header 认证(如 X-API-Key)必须手写依赖

当你的前端或第三方调用约定用 X-API-Key 而非 Authorization 时,HTTPBearer 就失效了。这时要写一个普通依赖函数,用 Request 对象手动取 Header。

示例代码片段:

from fastapi import Depends, HTTPException, Request
from starlette.status import HTTP_403_FORBIDDEN
<p>async def verify_api_key(request: Request):
api_key = request.headers.get("X-API-Key")
if not api_key:
raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail="X-API-Key header missing")
if api_key != "your-secret-key-here":  # 实际中建议查数据库或缓存
raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail="Invalid API Key")
return api_key

注意:

  • 别把密钥硬编码在代码里,应从环境变量读取:os.getenv("API_KEY")
  • 生产环境务必用更安全的存储方式(如 Vault、KMS),且避免明文比对,考虑加盐哈希或 token 签名验证
  • 这个函数返回值会注入到路由参数中,可选地用于日志或审计

如何在路由中应用 API Key 验证

把上面写的依赖函数传给 Depends(),就能保护单个接口或整个 router。

HISUI 前端框架开发指南(IRIS版)
HISUI 前端框架开发指南(IRIS版)

HISUI 前端框架基础开发指南。HISUI 是基于 easyui 二次开发的 jQuery UI 组件库,专为医疗信息系统设计。当涉及 HISUI 组件开发、jQuery easyui 表格/表单/布局/窗口、医疗系统前端页面编写时使用此 skill。 涵盖 40 个组件的官方文档参考,支持声明式与编程式两种初始化方式,提供 $cm/$m 数据访问方法。

下载

常见用法:

  • 保护单个接口:def read_items(api_key: str = Depends(verify_api_key)):
  • 保护整个 router:router = APIRouter(dependencies=[Depends(verify_api_key)])
  • 组合多个认证(比如部分接口允许 API Key,部分需要 OAuth2):用 Union 或分别定义不同依赖,但 FastAPI 不自动“或”逻辑,需手动写分支

错误响应默认是 403,如果你希望统一返回 401(Unauthorized),需显式设置 status_code=401 并调整 WWW-Authenticate Header,否则 OpenAPI 文档里会显示为 Forbidden。

容易忽略的部署与调试细节

本地开发时 curl 测试没问题,一上 Nginx 或 Cloudflare 就 403,大概率是反向代理默认过滤了自定义 Header。

排查要点:

  • Nginx 需显式透传:proxy_set_header X-API-Key $http_x_api_key;(注意大小写转换规则)
  • Cloudflare 免费版默认剥离所有非标准 Header,需升级或改用 Authorization: Bearer 格式
  • FastAPI 的 debug=True 不会影响认证逻辑,但错误堆栈可能暴露密钥——确保生产关闭 debug
  • 如果用 HTTPBearer,客户端误发 Authorization: API-Key xxx 会导致解析失败,报错信息是 Credentials not found in header,而非密钥错误

Header 名称大小写敏感,但 HTTP 协议规定 Header 名不区分大小写;实际中某些中间件(如某些 CDN)可能按字面匹配,建议统一用小写键名(x-api-key)并用 .get() 安全获取。

热门AI工具

更多
超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

423

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

4207

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

7085

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

601

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1516

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3998

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

122

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

577

2026.01.13

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

0

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn