Skip to content

仓内两处文档仍把 /api/v1/auth/login(及 /register、/logout、/session)列为已注册 auth 路由 —— 四条端点均不存在 #5772

Description

@baozhoutao

在 #5085(/auth/* 转发层删除遗留 POST ${prefix}/auth/login 显式路由)的实读中顺手发现,未认领,不在 #5085 的 PR 范围内。查重:is:open in:body "auth/login" 除 #5085 自身外零命中;stale docs routes 一类关键词亦零命中。

现象

两处仓内文档把根本不存在的 auth 端点写成「已注册路由」:

  1. packages/plugins/plugin-auth/IMPLEMENTATION_SUMMARY.md:88-92,标题就是 "API Routes Registered":

    - `POST /api/v1/auth/login` - User login (stub)
    - `POST /api/v1/auth/register` - User registration (stub)
    - `POST /api/v1/auth/logout` - User logout (stub)
    - `GET /api/v1/auth/session` - Get current session (stub)
    
  2. packages/client/CLIENT_SERVER_INTEGRATION_TESTS.md:642,MSW mock 示例把 rest.post('/api/v1/auth/login', …) 当成「Auth」的代表端点。

判读

这四条一条都不存在,而且不是「曾经存在后来删掉」:

同族的 packages/plugins/plugin-auth/ARCHITECTURE.md:74 不属于本条:那段 httpServer.post('/auth/login', …) 明确写在 "#### Before (Manual Approach)" 小节里,是在描述被取代的旧设计,框定正确,不需要改。

分级建议

Observation-class:今天没有用户会撞上 —— 这是两份仓内开发文档,不是发布文档站(content/docs/ 那份是对的)。危害是对下一个读者的:一个照着 IMPLEMENTATION_SUMMARY.md 的 "API Routes Registered" 去接的集成方会得到 404,而 CLIENT_SERVER_INTEGRATION_TESTS.md 的 mock 示例会教人按一个不存在的端点写测试 —— 这正是 Prime Directive #10 「never advertise a capability the runtime doesn't deliver」的文档侧。严重度按惯例交 PM 分诊,不在此自评。

修法方向

两份文档各改一处,与 content/docs/api/plugin-endpoints.mdx 对齐到 better-auth 的真实端点名(/auth/sign-in/email、/auth/sign-up/email、/auth/sign-out、/auth/get-session);IMPLEMENTATION_SUMMARY.md 那节若已无人维护,直接指向 auth-route-ledger.ts 比手抄一份更不容易再漂。

关联:#5085(发现现场)、#3656(auth 路由台账的来源)。

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions