Create API Specs
@Gloobinours 已经在做这个了。
开始于 2026年10月25日。
评估
这个 Issue 还没有评估数据。
描述
Description:
As a developer, I want to have an easy way to understand the API contracts so that I can code better.
Area of Responsibility
- backend
- documentation
Tasks:
- Create all endpoints with definitions
- Add examples to all endpoints that need them.
- Create all object schemas
- Create info and server section
Requirements (Acceptance Criteria):
- Done when an OpenAPI YAML file is created with all the API contracts.
Testing Reuirements:
- N/A
Always Make Sure:
- The implementation builds successfully.
- All tests written for the ticket, as well as all existing applicable tests, pass successfully.
- Any documentation affected by the change has been updated.
- The approved change has been successfully merged into main.
- 主要语言
- CSS
- 星标
- 3
- 派生
- 1
- 平均合并
- 22 小时 6 分钟
- 30 天内合并 PR
- 6
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business 的其他 Issue
-
Update README to declare license as GPL-3.0-or-later可能已有人在做 @or8655 于 2 天前认领。 未关闭documentation
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business#47 · 已指派 1 人 ·
-
难度 5/5 一周以上 新手友好度 20/100
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business#41 ·
-
难度 5/5 一周以上 新手友好度 15/100
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business#40 ·
-
难度 5/5 一周以上 新手友好度 10/100
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business#39 ·
-
SonarQube Setup未关闭
难度 5/5 一周以上 新手友好度 15/100
RIT-Software-Engineering/Open-Source-Sticker-Micro-Business#37 ·
查看 RIT-Software-Engineering/Open-Source-Sticker-Micro-Business 的全部 Issue