FastAPI_Simple_Security 常见问题解决方案

FastAPI_Simple_Security 常见问题解决方案

fastapi_simple_security Drop-in API-key based security for FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi_simple_security

项目基础介绍

FastAPI_Simple_Security 是一个为 FastAPI 框架提供的简单 API 密钥安全解决方案。该项目专注于使用的简便性，无需配置即可实现完整功能。它使用 SQLite 数据库作为后端，支持通过头部或查询参数进行 API 密钥安全认证。项目主要使用的编程语言是 Python。

新手常见问题与解决方案

问题一：如何安装和初始化项目

问题描述：新手在使用前不知道如何安装和初始化 FastAPI_Simple_Security。

解决步骤：

1. 确保你的环境中已经安装了 FastAPI 和 Uvicorn。
2. 使用 pip 命令安装 FastAPI_Simple_Security：

   pip install fastapi_simple_security
   

3. 在你的 FastAPI 应用中引入 api_key_router 和 api_key_security：

   from fastapi_simple_security import api_key_router, api_key_security
   

4. 将 api_key_router 添加到你的 FastAPI 应用中，并设置前缀和标签：

   app = FastAPI()
   app.include_router(api_key_router, prefix="/auth", tags=["_auth"])
   

问题二：如何生成和配置 API 密钥

问题描述：新手不知道如何生成 API 密钥，以及如何在应用中使用它。

解决步骤：

1. 如果没有提供环境变量 FASTAPI_SIMPLE_SECURITY_SECRET，启动 API 后，检查日志以获取自动生成的密钥。
2. 在 API 文档的 /docs 页面中，将自动生成的密钥填入 Authorize/Secret 头部信息中。
3. 使用 /auth/new 端点生成新的 API 密钥。
4. 在需要认证的安全端点中使用生成的 API 密钥。

问题三：如何隐藏管理员端点

问题描述：新手希望隐藏管理员端点，以防止密钥泄露。

解决步骤：

1. 设置环境变量 FASTAPI_SIMPLE_SECURITY_HIDE_DOCS 为 true 来隐藏管理员端点：

   export FASTAPI_SIMPLE_SECURITY_HIDE_DOCS=true
   

2. 确保所有管理员端点都通过头部认证来保护，以避免通过 URL 分享时泄露密钥。

fastapi_simple_security Drop-in API-key based security for FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi_simple_security