bunjs-apidog

此技能為 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 介面和業界標準客戶端產生的 1:1 對應。

• 利用 Apidog 平台功能，包括視覺化 API 設計、互動式文件、自動化測試和 Mock 伺服器功能。

• 管理複雜的 API 結構，包括安全方案（JWT bearerAuth）、分頁模型和錯誤回應標準。

• 需要設定環境變數 APIDOG_PROJECT_ID 和 APIDOG_API_TOKEN 以進行遠端同步。

• 旨在與其他 Bun.js 開發技能配合使用，以維護架構一致性。

• 專注於靜態分析與文件產生；請確保規格定期同步以符合生產環境程式碼變更。

• 在記錄新端點、重構現有資料契約，或建立需要最新 API 文件的 CI/CD 工作流程時使用此技能。

• 在匯入 Apidog 前，務必使用標準 OpenAPI 解析器驗證產生的規格，以偵測架構定義錯誤。