add: some user api and all api desc
This commit is contained in:
@@ -0,0 +1,55 @@
|
||||
syntax = "v1"
|
||||
|
||||
info (
|
||||
title: "聚玩认证审核服务"
|
||||
desc: "处理用户角色认证申请(打手/店长)及管理员审核流程"
|
||||
author: "Asadz"
|
||||
version: "1.0"
|
||||
)
|
||||
|
||||
// =================================================================================
|
||||
// 数据结构定义 (Data Structures)
|
||||
// =================================================================================
|
||||
|
||||
// =================================================================================
|
||||
// 用户端接口 (User Side)
|
||||
// 路径前缀: /api/v1/users
|
||||
// =================================================================================
|
||||
@server (
|
||||
group: verification_user
|
||||
prefix: /api/v1/users
|
||||
jwt: Auth // 必须登录
|
||||
)
|
||||
service verification-api {
|
||||
@doc "提交或修改角色认证申请 (支持幂等更新)"
|
||||
@handler ApplyVerification
|
||||
post /me/verification (ApplyVerificationReq) returns (VerificationEmptyResp)
|
||||
|
||||
@doc "获取我的所有认证状态"
|
||||
@handler GetMyVerifications
|
||||
get /me/verification returns (GetMyVerificationsResp)
|
||||
}
|
||||
|
||||
// =================================================================================
|
||||
// 管理端接口 (Admin Side)
|
||||
// 路径前缀: /api/v1/admin
|
||||
// =================================================================================
|
||||
@server (
|
||||
group: verification_admin
|
||||
prefix: /api/v1/admin
|
||||
jwt: Auth // 需要登录,且 Logic 层需校验 IsAdmin
|
||||
)
|
||||
service verification-api {
|
||||
@doc "管理员获取认证申请列表 (分页)"
|
||||
@handler GetVerifications
|
||||
get /verifications (GetPendingListReq) returns (GetPendingListResp)
|
||||
|
||||
@doc "管理员通过申请"
|
||||
@handler ApproveVerification
|
||||
post /verifications/:id/approve (VerificationIdReq) returns (VerificationEmptyResp)
|
||||
|
||||
@doc "管理员驳回申请"
|
||||
@handler RejectVerification
|
||||
post /verifications/:id/reject (RejectVerificationReq) returns (VerificationEmptyResp)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user