diff --git a/AGENTS.md b/AGENTS.md index a9f1d94..72ae802 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -18,12 +18,12 @@ - 不需要实现登录页,默认访问应用的用户都是已登录状态 - 所有请求统一使用 `/src/api/index` 中的 `api` 方法进行调用,因为已经内置了必要的请求头封装 - 如果有需要,使用 `/src/api/user` 中的 `getUserInfo` 方法获取当前用户信息 -- 如果有需要,使用 `/src/api/user` 中的 `getGroupUsers` 方法获取全部用户信息列表 +- 如果有需要,使用 `/src/api/user` 中的 `getGroupMembers` 方法获取全部用户信息列表 ### 2. 后端实现策略 - 所有接口以 `/api` 为前缀 -- 已经为项目封装了当前用户信息获取的逻辑,提供了中间件,`userInfoMiddleware`,见: `src/middleware/auth.ts` -- 已经为项目封装了当前群组所有用户信息列表的获取逻辑,提供了中间件,`groupInfoMiddleware`,见: `src/middleware/auth.ts` +- 所有接口按照 `tsoa` 规范来编写,参考 `src/controllers` 目录下的 `UserController`、`GroupController` 示例 +- 如果接口需要登录,请使用 `@Security('jwt')` 装饰器,tsoa 会自动调用登录校验,并把 user 信息写到req上,参考 `UserController` 示例 ### 3. 开发规范 - **文件命名**: 使用kebab-case命名文件和文件夹