API key学习笔记

xiaomu_347

已于 2024-06-06 13:44:59 修改

阅读量4.1k

点赞数 25

文章标签：学习笔记服务器

于 2024-06-05 23:43:44 首次发布

本文链接：https://blog.csdn.net/xiaomu_347/article/details/139484701

版权

API Key 基本上可以认为是一个长字符串，允许 API 消费者（即使用 API 的人）访问受限的功能和数据。它作为一种安全措施，确保了 API 服务能够控制谁有权限访问什么数据，同时也帮助跟踪API的使用情况。生成API key来调用API是为了安全、控制和管理API访问的。这也就是为啥生产环境往往都需要加上key来进行第一步验证了。下面对此进行简单总结：

一、为什么要生成API key？

身份验证：
- API key用于识别调用者的身份，以确保只有授权的用户才能访问API。
访问控制：
- API key可以设置不同的权限级别，从而控制用户可以访问哪些API功能。
使用限制：
- 通过API key，可以对每个用户的API调用次数进行限制，防止滥用。
监控和记录：
- 使用API key可以跟踪和记录每个用户的API调用情况，以便进行分析和故障排除。
安全性：
- API key是防止未授权访问和保护数据的第一道防线。

二、如何生成API key？

生成API key的过程可能会因平台或服务提供商的不同而有所差异，但一般步骤如下：

注册和登录：
- 首先，需要在提供API服务的平台上注册一个账户并登录。
创建API项目：
- 在大多数平台上，需要创建一个新的API项目或应用程序。在创建过程中，通常会要求提供一些基本信息，如项目名称、描述等。
生成API key：
- 在项目设置或API设置页面，通常会有一个选项用于生成新的API key。点击生成API key按钮后，平台会生成一个唯一的密钥字符串。
保存API key：
- 生成的API key通常只会显示一次，所以需要妥善保存。建议将其存储在安全的地方，例如环境变量或安全存储管理工具中。
配置API key：
- 在实际使用API时，需要将生成的API key包含在API请求的头部、参数或配置文件中，以便进行身份验证。

三、示例

》在Google Cloud Platform上生成API key

登录到Google Cloud Platform控制台。
创建一个新的项目或选择一个现有项目。
导航到API和服务 -> 凭据。
点击“创建凭据”按钮，并选择“API密钥”。
系统会生成一个新的API密钥。将其复制并保存。

不同平台的具体操作可能会有所不同，但基本流程是相似的。如果你有特定的平台或API需要生成API key，可以提供更多信息，我可以提供更详细的指导。比如大模型openai qwen等提供的API key访问，申请流程差不多，按需付费即可。

》基于python和fastapi快速生成一个自己api服务的key，以及如何使用验证
（1）sever端main.py

from fastapi import FastAPI, Depends, HTTPException, Header
from typing import Optional
import uuid

app = FastAPI()

# 这里我们将API key存储在内存中，实际应用中应使用数据库或其他安全存储
api_keys = {
   }

# 生成API key并存储
def create_api_key(user: str) -> str:
    api_key = str(uuid.uuid4())
    api_keys[api_key] = user
    return api_key

# 验证API key
def verify_api_key(x_api_key: str = Header(...)):
    if x_api_key not in api_keys:
        raise HTTPException(status_code=401, detail="Invalid API Key")

# 生成API key的端点
@app.post("/generate_api_key")
def generate_api_key(u