avatar-api/desc/core/token.api

import "../base.api"

type (
    // The response data of token information | 令牌信息
    TokenInfo {
        BaseUUIDInfo

        // Status | 状态
        Status *uint32 `json:"status,optional"`

        // User's UUID | 用户的UUID
        Uuid *string `json:"uuid,optional"`

        // Token | 用户的Token
        Token *string `json:"token,optional"`

        // Source | Token 来源
        Source *string `json:"source,optional"`

        // Username | 用户名
        Username *string `json:"username,optional"`

        // ExpiredAt | 过期时间
        ExpiredAt *int64 `json:"expiredAt,optional"`
    }

    // The response data of token list | 令牌列表数据
    TokenListResp {
        BaseDataInfo

        // Token list data | 令牌列表数据
        Data TokenListInfo `json:"data"`
    }

    // Token list data | Token列表数据
    TokenListInfo {
        BaseListInfo

        // The API list data | 令牌列表数据
        Data  []TokenInfo  `json:"data"`
    }

    // Get token list request params | 令牌列表请求参数
    TokenListReq {
        PageInfo

        // Username | 用户名
        Username *string `json:"username,optional"`

        // Nickname | 昵称
        Nickname *string `json:"nickname,optional"`

        // Email | 邮箱
        Email *string `json:"email,optional"`

        // UUID
        Uuid *string `json:"uuid,optional"`
    }

    // Token information response | Token信息返回体
    TokenInfoResp {
        BaseDataInfo

        // Token information | Token数据
        Data TokenInfo `json:"data"`
    }
)

@server(
    jwt: Auth
    group: token
    middleware: Authority
)

service Core {
    // Create token information | 创建令牌
    @handler createToken
    post /token/create (TokenInfo) returns (BaseMsgResp)

    // Update token information | 更新令牌
    @handler updateToken
    post /token/update (TokenInfo) returns (BaseMsgResp)

    // Delete token information | 删除令牌信息
    @handler deleteToken
    post /token/delete (UUIDsReq) returns (BaseMsgResp)

    // Get token list | 获取令牌列表
    @handler getTokenList
    post /token/list (TokenListReq) returns (TokenListResp)

    // Get Token by ID | 通过ID获取令牌
    @handler getTokenById
    post /token (UUIDReq) returns (TokenInfoResp)

    // Force logging out by user UUID | 根据UUID强制用户退出
    @handler logout
    post /token/logout (UUIDReq) returns (BaseMsgResp)
}