feat: 每个接口都需要写 @Example 装饰器

This commit is contained in:
dayjoy
2025-10-11 18:10:40 +08:00
parent 1659d03040
commit 97bd5d013b

View File

@@ -25,6 +25,8 @@
- 所有接口以 `/api` 为前缀
- 所有接口按照 `tsoa` 规范来编写,参考 `src/controllers` 目录下的 `UserController``GroupController` 示例
- 如果接口需要登录,请使用 `@Security('jwt')` 装饰器tsoa 会自动调用登录校验,并把 user 信息写到req上参考 `UserController` 示例
- **每个接口都需要通过 `@Example` 装饰器,写接口返回数据的示例,至少写一个例子**
- **如果有入参,每个接口还需要通过 `@Example` 装饰器,再写一个接口入参数据的示例,至少写一个例子。没有入参则不用写例子**
### 3. 开发规范
- **文件命名**: 使用kebab-case命名文件和文件夹