配置文件 API

1. "获取当前用户资料"

  1. route definition
  • Url: /api/v1/profile
  • Method: GET
  • Request: ProfileGetRequest
  • Response: ProfileGetResponse
  1. request definition
type ProfileGetRequest struct {
}
  1. response definition
type ProfileGetResponse struct {
	Id int64 `json:"id"`
	Username string `json:"username"`
	Nickname string `json:"nickname"`
	Email string `json:"email"`
	Phone string `json:"phone"`
	Roles []string `json:"roles"`
	Avatar string `json:"avatar"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

type ProfileInfo struct {
	Id int64 `json:"id"`
	Username string `json:"username"`
	Nickname string `json:"nickname"`
	Email string `json:"email"`
	Phone string `json:"phone"`
	Roles []string `json:"roles"`
	Avatar string `json:"avatar"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

2. "更新当前用户资料"

  1. route definition
  • Url: /api/v1/profile
  • Method: PUT
  • Request: ProfileUpdateRequest
  • Response: ProfileGetResponse
  1. request definition
type ProfileUpdateRequest struct {
	Nickname string `json:"nickname,optional"`
	Email string `json:"email,optional"`
	Phone string `json:"phone,optional"`
	Avatar string `json:"avatar,optional"`
}
  1. response definition
type ProfileGetResponse struct {
	Id int64 `json:"id"`
	Username string `json:"username"`
	Nickname string `json:"nickname"`
	Email string `json:"email"`
	Phone string `json:"phone"`
	Roles []string `json:"roles"`
	Avatar string `json:"avatar"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

type ProfileInfo struct {
	Id int64 `json:"id"`
	Username string `json:"username"`
	Nickname string `json:"nickname"`
	Email string `json:"email"`
	Phone string `json:"phone"`
	Roles []string `json:"roles"`
	Avatar string `json:"avatar"`
	CreatedAt string `json:"createdAt"`
	UpdatedAt string `json:"updatedAt"`
}

3. "获取我的游戏"

  1. route definition
  • Url: /api/v1/profile/games
  • Method: GET
  • Request: ProfileGamesRequest
  • Response: ProfileGamesResponse
  1. request definition
type ProfileGamesRequest struct {
}
  1. response definition
type ProfileGamesResponse struct {
	Games []ProfileGame `json:"games"`
}

4. "修改密码"

  1. route definition
  • Url: /api/v1/profile/password
  • Method: PUT
  • Request: ProfilePasswordRequest
  • Response: -
  1. request definition
type ProfilePasswordRequest struct {
	OldPassword string `json:"oldPassword"`
	NewPassword string `json:"newPassword"`
}
  1. response definition

5. "获取当前用户权限"

  1. route definition
  • Url: /api/v1/profile/permissions
  • Method: GET
  • Request: ProfilePermissionsRequest
  • Response: ProfilePermissionsResponse
  1. request definition
type ProfilePermissionsRequest struct {
	GameId string `form:"gameId,optional"`
	Env string `form:"env,optional"`
}
  1. response definition
type ProfilePermissionsResponse struct {
	Permissions []ProfilePermission `json:"permissions"`
	Admin bool `json:"admin"`
	Roles []string `json:"roles"`
	PermissionIDs []string `json:"permissionIDs,omitempty"`
}