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

1.6 KiB

Developer Guide

Use this page as the English navigation layer for the shared bilingual engineering references.

Start Here

  1. Code structure reference
  2. API overview
  3. Authentication and authorization
  4. Endpoint matrix
  5. Error conventions
  6. Testing baseline

What Each Detailed Page Answers

  • Code structure reference Which package owns what, which exported types matter, which non-exported owners carry runtime behavior, and how the core packages connect.
  • API overview How route families are organized, where handlers live, and how authentication layers stack.
  • Authentication and authorization Request and response fields for session login, MFA, OAuth exchange, JWT refresh, password reset, and XWorkmate secret flows.
  • Endpoint matrix Method, path, owner file, auth mode, request parameters, response shape, and dependency wiring for the current route set.
  • Testing baseline The verification baseline for docs and code alignment, centered on go test ./....

Validation Baseline

The documentation was aligned against current source, then validated with:

go test ./...

If you update routes, type signatures, or package ownership, update the detailed pages above in the same change.