Unkey项目:关于API密钥创建时使用keyspace默认值的优化方案
2025-06-11 07:11:58作者:秋泉律Samson
在Unkey项目中,API密钥管理是一个核心功能。最近开发团队发现了一个可以优化的地方:在通过API创建新密钥时,系统应该能够自动回退到使用keyspace中预设的默认值。
当前实现的问题
目前Unkey的数据库schema中已经存储了defaultPrefix和defaultBytes等默认值(位于internal/db/src/schema/keyAuth.ts),但在实际通过API创建密钥时,这些默认值并没有被充分利用。当用户没有在请求体中明确指定bytes或prefix参数时,系统不会自动使用这些预设的默认值。
技术解决方案
要解决这个问题,主要需要修改以下文件:
- /apps/api/src/routes/v1_keys_createKey.ts - 这是处理密钥创建请求的主要路由文件
- /apps/api/src/routes/v1_keys_createKey.happy.test.ts - 需要添加相应的测试用例
修改的核心逻辑是:
- 在接收创建密钥的API请求时
- 检查请求体中是否包含bytes和prefix参数
- 如果这些参数缺失,则从keyAuth表中查询对应的默认值
- 使用这些默认值来创建新的API密钥
实现细节
在技术实现上,需要注意以下几点:
- 数据库查询优化:在获取默认值时应该高效查询,避免不必要的数据库负载
- 参数优先级:明确参数优先级顺序 - 显式指定的参数 > keyspace默认值 > 系统全局默认值
- 错误处理:当既没有指定参数又没有设置默认值时,应该返回明确的错误信息
- 向后兼容:确保修改不会影响现有API客户端的行为
测试策略
为了确保修改的正确性,需要添加以下测试场景:
- 测试当不提供prefix和bytes时,系统是否正确地使用了keyspace默认值
- 测试当提供部分参数时,系统是否正确组合了显式参数和默认值
- 测试当既没有参数又没有默认值时的错误处理
- 测试修改是否影响现有API客户端的正常使用
项目意义
这个优化虽然看似简单,但实际上有重要意义:
- 提升用户体验:减少了必须参数的数量,使API更友好
- 保持一致性:确保同一keyspace下的密钥具有一致的默认特征
- 减少错误:避免了因为忘记设置某些参数而导致的密钥不一致问题
- 灵活性:既保留了自定义参数的能力,又提供了合理的默认值
这个改进体现了Unkey项目对开发者体验的重视,通过合理的默认值设置,让API使用更加简单直观,同时又不失灵活性。
登录后查看全文
热门项目推荐
相关项目推荐
AutoGLM-Phone-9BAutoGLM-Phone-9B是基于AutoGLM构建的移动智能助手框架,依托多模态感知理解手机屏幕并执行自动化操作。Jinja00
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
GLM-4.6V-FP8GLM-4.6V-FP8是GLM-V系列开源模型,支持128K上下文窗口,融合原生多模态函数调用能力,实现从视觉感知到执行的闭环。具备文档理解、图文生成、前端重构等功能,适用于云集群与本地部署,在同类参数规模中视觉理解性能领先。Jinja00
HunyuanOCRHunyuanOCR 是基于混元原生多模态架构打造的领先端到端 OCR 专家级视觉语言模型。它采用仅 10 亿参数的轻量化设计,在业界多项基准测试中取得了当前最佳性能。该模型不仅精通复杂多语言文档解析,还在文本检测与识别、开放域信息抽取、视频字幕提取及图片翻译等实际应用场景中表现卓越。00
GLM-ASR-Nano-2512GLM-ASR-Nano-2512 是一款稳健的开源语音识别模型,参数规模为 15 亿。该模型专为应对真实场景的复杂性而设计,在保持紧凑体量的同时,多项基准测试表现优于 OpenAI Whisper V3。Python00
GLM-TTSGLM-TTS 是一款基于大语言模型的高质量文本转语音(TTS)合成系统,支持零样本语音克隆和流式推理。该系统采用两阶段架构,结合了用于语音 token 生成的大语言模型(LLM)和用于波形合成的流匹配(Flow Matching)模型。 通过引入多奖励强化学习框架,GLM-TTS 显著提升了合成语音的表现力,相比传统 TTS 系统实现了更自然的情感控制。Python00
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
24
9
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
402
3.13 K
Ascend Extension for PyTorch
Python
224
249
暂无简介
Dart
672
159
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
663
316
React Native鸿蒙化仓库
JavaScript
262
325
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.2 K
655
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
64
19
openGauss kernel ~ openGauss is an open source relational database management system
C++
160
219