工程开发
bunjs-apidog avatar

bunjs-apidog

为 Bun.js TypeScript 后端自动化 OpenAPI 3.0 规范建立、Apidog 同步与 API 文档生命周期管理。

简介

此技能为 Bun.js 生态系统中的 API 文档管理提供了一套强大的框架。它专为需要维护同步、高质量 OpenAPI 3.0 规范,同时利用 Apidog 平台进行设计、测试和 Mock 的后端开发人员与 API 工程师所设计。通过强制执行严格的 camelCase 命名惯例和可重复使用的组件化架构设计,该技能确保您的 API 契约与 TypeScript 标准及行业最佳实践保持一致。它简化了 API 文档生命周期,从初始规范编写到通过 REST API 集成与远程 Apidog 项目进行自动同步。

  • 为 Bun.js HTTP 服务器路由和数据模型生成兼容的 OpenAPI 3.0 规范。

  • 使用基于环境变量的身份验证,自动将 API 规范导入并同步至 Apidog 项目中。

  • 在 components.schemas 中实现可重复使用的架构,以减少冗余并确保 API 定义间的类型安全性。

  • 强制执行 camelCase JSON 字段命名,保证与 TypeScript 接口和行业标准客户端生成的一对一对应。

  • 利用 Apidog 平台功能,包括可视化 API 设计、交互式文档、自动化测试和 Mock 服务器功能。

  • 管理复杂的 API 结构,包括安全方案(JWT bearerAuth)、分页模型和错误响应标准。

  • 需要配置环境变量 APIDOG_PROJECT_ID 和 APIDOG_API_TOKEN 以进行远程同步。

  • 旨在与其他 Bun.js 开发技能配合使用,以维护架构一致性。

  • 专注于静态分析与文档生成;请确保规范定期同步以符合生产环境代码变更。

  • 在记录新端点、重构现有数据契约,或建立需要最新 API 文档的 CI/CD 工作流程时使用此技能。

  • 在导入 Apidog 前,务必使用标准 OpenAPI 解析器验证生成的规范,以检测架构定义错误。

仓库统计

Star 数
255
Fork 数
31
Open Issue 数
7
主要语言
TypeScript
默认分支
main
同步状态
空闲
最近同步时间
2026年4月30日 16:33
在 GitHub 查看