0xironclad / 0xironclad/Task-Scheduler-API
Add OpenAPI spec
未關閉
api
docs
- 主要語言
- TypeScript
- 星號
- 0
- 分支
- 2
- PR 合併指標
- 30 天內沒有已合併 PR
描述
Document endpoints, payloads, and error shapes in a `openapi.yaml`. Optional Swagger UI.
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
檢查程式碼庫中現有的 Express 路由，以了解端點、請求/回應承載和錯誤格式。建立一個 openapi.yaml 檔案來記錄這些內容。可選地，整合一個 Swagger UI 套件來提供規格。透過測試端點來驗證規格是否與實際 API 行為相符。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- express, node.js, openapi, typescript
- 領域
- api, documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 55/100