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