devup-api
基于OpenAPI规范,自动生成类型安全的API客户端。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:devup-api。 它的用途是:基于OpenAPI规范,自动生成类型安全的API客户端。 完整的 Skill 内容见:https://321skill.com/skills/devup-api/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“帮我在React组件中调用用户列表接口。”,它会引导你安装 devup-api,配置 openapi.json 路径,然后生成类似 `api.user.list({ page: 1 })` 的调用代码,并自动补全参数和响应类型。或者说:“我的API响应结构变了,怎么更新类型?”,它会提示你重新运行构建命令,devup-api 会自动根据最新的 OpenAPI 文件重新生成类型。
介绍
devup-api 解决了前端、后端及全栈开发者在调用API时需要手动编写类型声明和客户端代码的痛点。它通过读取项目的 OpenAPI 规范文件,在构建时自动生成一套与原生 fetch 兼容但完全类型化的客户端函数,开发者可以直接调用,无需处理泛型或编写SDK样板代码。
使用方式非常简单:在项目中安装 @devup-api/fetch 包,配置好指向 openapi.json 的路径,运行构建命令后,即可在代码中导入生成的客户端,像调用普通函数一样发起类型安全的API请求。它支持路径参数、查询参数、请求体等所有OpenAPI定义的参数类型,并自动推断响应类型。
这个工具非常适合前端开发、后端开发和全栈开发人员,尤其是那些使用TypeScript并希望提升API调用类型安全性和开发效率的团队。对于维护大型或API频繁变更的项目,它能显著减少因接口变动导致的类型错误。
建议在项目初期或引入OpenAPI规范后立即集成,以最大化其价值。注意,它依赖于准确且最新的OpenAPI规范文件,因此需要确保后端API文档的及时更新。对于不使用OpenAPI或项目结构极其简单的场景,其收益可能不明显。
核心特点
与同类工具相比,devup-api 强调“零泛型”和“类fetch体验”,生成的客户端函数直接可用,无需开发者手动传递泛型参数,极大简化了调用代码。同时,它深度集成构建工具,支持“冷热类型”切换,在生成文件前提供基础类型提示,生成后提供完整类型,开发体验更流畅。
注意事项
不适合没有使用OpenAPI规范或API文档不准确的项目。
常见问题
devup-api 和手动写 fetch 调用有什么区别?
它自动为你生成类型安全的函数,省去了手动定义请求参数类型、响应类型和拼接URL的步骤,并能提前发现类型错误。
支持 Next.js 的 Server Actions 吗?
支持,devup-api 可以自动从 OpenAPI 的 operationId 生成可直接在 Next.js 中使用的 Server Action 函数。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/devup-api/raw/index.md 读取 devup-api 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/devup-api/raw/index.md(查看排版版本)