Files
juwan-backend/desc/api/common.api
T
2026-02-27 19:17:01 +08:00

47 lines
1.4 KiB
Plaintext

syntax = "v1"
info(
title: "公共定义"
desc: "Common structures"
author: "Juwan Team"
version: "1.0"
)
type (
// 分页请求基础
PageReq {
Offset int64 `form:"offset,default=0"`
Limit int64 `form:"limit,default=20"`
}
// 分页响应元数据
PageMeta {
Total int64 `json:"total"`
Offset int64 `json:"offset"`
Limit int64 `json:"limit"`
}
// 空响应
EmptyResp {}
// 核心用户画像 (被 Auth, Community, Shop 等多个服务引用)
UserProfile {
Id string `json:"id"`
Username string `json:"username"`
Nickname string `json:"nickname"`
Avatar string `json:"avatar"`
Role string `json:"role"` // consumer, player, owner, admin
VerifiedRoles []string `json:"verifiedRoles"`
VerificationStatus map[string]string `json:"verificationStatus"`
Phone string `json:"phone,optional"`
Bio string `json:"bio,optional"`
CreatedAt string `json:"createdAt"`
}
// 简略用户信息 (用于列表、聊天头像等)
SimpleUser {
Id string `json:"id"`
Nickname string `json:"nickname"`
Avatar string `json:"avatar"`
}
)