fix: example改为字段描述和example

This commit is contained in:
dayjoy
2025-10-13 14:13:37 +08:00
parent defe5ac49b
commit 2f38d95e8c
6 changed files with 63 additions and 47 deletions

View File

@@ -25,8 +25,19 @@
- 所有接口以 `/api` 为前缀
- 所有接口按照 `tsoa` 规范来编写,参考 `src/controllers` 目录下的 `UserController``GroupController` 示例
- 如果接口需要登录,请使用 `@Security('jwt')` 装饰器tsoa 会自动调用登录校验,并把 user 信息写到req上参考 `UserController` 示例
- **每个接口都需要通过 `@Example` 装饰器,写接口返回数据的示例,至少写一个例子**
- **如果有入参,每个接口还需要通过 `@Example` 装饰器,再写一个接口入参数据的示例,至少写一个例子。没有入参则不用写例子**
- **每个接口相关的类型定义(如interface、type)等都需要按照标准注释进行类型及字段的描述注释。不明确的字段如string类型的日期等还需要加上 @example 表明字段具体的格式示例**,例如:
```ts
/**
* 用户ID
* @example "123456"
*/
id: string;
/**
* 注册日期格式为yyyy-MM-dd
* @example "2025-01-01"
*/
registryDate: string;
```
### 3. 开发规范
- **文件命名**: 使用kebab-case命名文件和文件夹