请求约定
Base URL
api_service 是唯一的内部管理 HTTP 边界,部署地址由环境注入(调用方配置项 API_SERVICE_URL)。全部业务路由挂载在 /api/v1 之下;/health 与 /metrics 为运维端点,豁免该前缀。
认证
- 需要登录态的接口携带会话令牌:
Authorization: Bearer <sessionToken>。会话令牌为不透明随机串,服务端回源内省校验。 - 管理域(
/api/v1/admin/...)在会话之上还要求管理角色,权限不足返回共享码1003。
公共约定
- 请求体
Content-Type: application/json。 - 分页:query 参数
page(默认1)与pageSize(默认20,上限100);result形如{items, total, page, pageSize}。 - 标识符:26 位 ULID 字符串。
- 时间:ISO 8601 UTC(如
2026-10-14T08:00:00Z)。 - 环境指纹:登录类接口由服务端从请求头与网络层提取(来源 IP、
User-Agent等),调用方无需显式传递。 - NATS subject 的命名、连接与超时语义见各服务目录页。