如何建开发手机网站,阳江做网站seo,公司网站如何建设教程,网站优化排名查询文章目录 01 前言02 路径传参方式添加API Key2.1 完整代码2.2 请求示例2.3 swagger文档测试 03 请求头Header方式传入API Key#xff08;推荐#xff09;3.1 完整代码3.2 请求示例3.3 swagger文档测试 01 前言
FastAPI#xff0c;如其名所示#xff0c;是一个极为高效的框… 文章目录 01 前言02 路径传参方式添加API Key2.1 完整代码2.2 请求示例2.3 swagger文档测试 03 请求头Header方式传入API Key推荐3.1 完整代码3.2 请求示例3.3 swagger文档测试 01 前言
FastAPI如其名所示是一个极为高效的框架特别适用于构建 API 后端服务。而在与其他网站的 API 接口进行交互时API Key认证是一种非常普遍的安全机制。典型的例子是ChatGPT的接口我们需要申请一个专属的API Key才能发起有效的请求。
虽然我们可以直接在定义接口时自定义接收参数但这种方式需要在每个接口都增加相同的代码十分不优雅且该方式不支持FastAPI自带的swagger文档友好显示。
本文将介绍在FastAPI框架中如何为我们的后端服务添加API Key认证且使用两种不同的方案实现一种是将 API Key 放在 URL 请求路径中另一种是将 API Key 放在请求头Header中。
02 路径传参方式添加API Key
2.1 完整代码
import uvicorn
from fastapi import HTTPException, status, Security, FastAPI
from fastapi.security import APIKeyQuery# 可用的API_KEYS列表
API_KEYS [9d207bf0-10f5-4d8f-a479-22ff5aeff8d1, ...]# 创建一个用于解析路径传参的对象
api_key_query APIKeyQuery(nameapi-key, auto_errorFalse)# 定义一个获取请求中的api-key的函数 该函数接收一个上一步创建的对象封装
def get_api_key(api_key: str Security(api_key_query)) - str:if api_key in API_KEYS:return api_keyraise HTTPException(status_codestatus.HTTP_401_UNAUTHORIZED, detailInvalid or missing API Key)app FastAPI()app.get(/public)
def public():一个公共接口 无需api-key即可访问return Public Endpoint.# 需要api-key的接口注意接受参数的写法。
app.get(/private)
def private(api_key: str Security(get_api_key)):一个私有端点 需要在请求url中传入api-keyreturn fPrivate Endpoint. API Key: {api_key}if __name__ __main__:uvicorn.run(app, host0.0.0.0, port8000)2.2 请求示例
启动应用后可以使用如下请求来访问“私有端点”
GET http://localhost:8000/private?api-key9d207bf0-10f5-4d8f-a479-22ff5aeff8d12.3 swagger文档测试
访问接口文档可以看到有很好的支持。
点击Authorize按钮填入api-key这样调用需要认证的接口时就可以自动带上api-key了。 03 请求头Header方式传入API Key推荐
3.1 完整代码
这种方式相对前一种方式会更安全一些推荐。
为请求添加api-key的示例 api-key通过header的方式发送
import uvicorn
from fastapi import HTTPException, status, Security, FastAPI
from fastapi.security import APIKeyHeader# 可用的API_KEYS列表
API_KEYS [9d207bf0-10f5-4d8f-a479-22ff5aeff8d1, ...]# 创建一个用于解析路径传参的对象
api_key_header APIKeyHeader(nameapi-key, auto_errorFalse)# 定义一个获取请求中的api-key的函数 该函数接收一个上一步创建的对象封装
def get_api_key(api_key: str Security(api_key_header)) - str:if api_key in API_KEYS:return api_keyraise HTTPException(status_codestatus.HTTP_401_UNAUTHORIZED, detailInvalid or missing API Key)app FastAPI()app.get(/public)
def public():一个公共接口 无需api-key即可访问return Public Endpoint.# 需要api-key的接口注意接受参数的写法。
app.get(/private)
def private(api_key: str Security(get_api_key)):一个私有端点 需要在请求url中传入api-keyreturn fPrivate Endpoint. API Key: {api_key}if __name__ __main__:uvicorn.run(app, host0.0.0.0, port8000)3.2 请求示例
启动应用后你可以使用如下 curl 命令来访问“私有端点”
curl -H api-key: 9d207bf0-10f5-4d8f-a479-22ff5aeff8d1 http://localhost:8000/private3.3 swagger文档测试 配置完成一切正常
完
