qnc-server/app/user/cmd/api/desc/user.api

85 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

2024-11-03 15:28:10 +08:00
syntax = "v1"
info (
title: "用户中心服务"
desc: "用户中心服务"
author: "Liangzai"
email: "2440983361@qq.com"
version: "v1"
)
import (
"user/user.api"
"auth/auth.api"
)
//============================> user v1 <============================
//no need login
@server (
2024-11-21 12:14:34 +08:00
prefix: api/v1
2024-11-03 15:28:10 +08:00
group: user
)
2024-11-21 12:14:34 +08:00
service main {
2024-11-03 15:28:10 +08:00
@doc "register"
@handler register
post /user/register (RegisterReq) returns (RegisterResp)
@doc "mobile login"
@handler mobileLogin
post /user/mobileLogin (MobileLoginReq) returns (MobileLoginResp)
@doc "mobile code login"
@handler mobileCodeLogin
post /user/mobileCodeLogin (MobileCodeLoginReq) returns (MobileCodeLoginResp)
2024-12-24 11:37:25 +08:00
@doc "wechat mini auth"
@handler wxMiniAuth
post /user/wxMiniAuth (WXMiniAuthReq) returns (WXMiniAuthResp)
@doc "wechat h5 auth"
@handler wxH5Auth
post /user/wxh5Auth (WXH5AuthReq) returns (WXH5AuthResp)
2025-04-04 01:02:26 +08:00
@handler DecryptMobile
post /user/decryptMobile
2024-11-03 15:28:10 +08:00
}
//need login
@server (
2024-11-21 12:14:34 +08:00
prefix: api/v1
2024-11-03 15:28:10 +08:00
group: user
jwt: JwtAuth
)
2024-11-21 12:14:34 +08:00
service main {
2024-11-03 15:28:10 +08:00
@doc "get user info"
@handler detail
2024-11-21 12:14:34 +08:00
get /user/detail returns (UserInfoResp)
2025-02-18 15:23:26 +08:00
@doc "get new token"
@handler getToken
post /user/getToken returns (MobileCodeLoginResp)
2024-11-03 15:28:10 +08:00
}
//============================> auth v1 <============================
@server (
2024-11-21 12:14:34 +08:00
prefix: api/v1
2024-11-03 15:28:10 +08:00
group: auth
)
2024-11-21 12:14:34 +08:00
service main {
2024-11-03 15:28:10 +08:00
@doc "get mobile verify code"
@handler sendSms
post /auth/sendSms (sendSmsReq)
}
2025-01-01 02:00:06 +08:00
//============================> notification v1 <============================
@server (
prefix: api/v1
group: notification
)
service main {
@doc "get notifications"
@handler getNotifications
get /notification/list returns (GetNotificationsResp)
}