accounts/docs/zh/developer-guide.md
2026-04-14 16:32:15 +08:00

1.5 KiB

开发手册

本页是共享双语工程参考页的中文导航层。

建议起步顺序

  1. 代码结构参考
  2. API 总览
  3. 认证与鉴权
  4. 接口矩阵
  5. 错误约定
  6. 测试基线

每个细页回答什么问题

  • 代码结构参考 看核心包由谁负责、哪些导出类型重要、哪些非导出 owner 承担主流程,以及各包之间如何连接。
  • API 总览 看路由族如何划分、handler 分布在哪些文件里、认证层是怎样叠加的。
  • 认证与鉴权 看 session 登录、MFA、OAuth exchange、JWT refresh、密码重置、XWorkmate secret API 的请求/返回字段。
  • 接口矩阵 看方法、路径、owner file、鉴权方式、请求参数、返回形状与主要依赖对象。
  • 测试基线 看当前文档与代码一致性的校验方式,核心基线是 go test ./...

校验基线

本轮文档补齐以源码为事实源,并通过以下命令校验:

go test ./...

如果你修改了路由、类型签名、handler 归属或主依赖对象,应同步更新上面的细页。

相关页面