手把手开发Admin 系列五（规划api篇）

已于 2022-08-31 13:45:16 修改
阅读量470 收藏 1
点赞数
分类专栏： arkAdmin 文章标签： go go-zero admin
于 2022-08-31 13:31:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lwqBrell/article/details/126622115
版权

文档：https://docs.arklnk.com

前端：https://github.com/arklnk/ark-admin-vuenext

后端：https://github.com/arklnk/ark-admin-zero

go-zero：https://go-zero.dev/cn

演示： http://arkadmin.si-yee.com

账号密码备注
demo123456演示账号

编写api文件

配置管理

字典管理

路径：app/core/cmd/api/desc/config/dict.api

syntax = "v1"

info(
	title: "字典"
	desc: "字典"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	ConfigDict {
		Id        uint64 `json:"id"`
		ParentId  uint64 `json:"parentId"`
		Name      string `json:"name"`
		Type      uint64 `json:"type"`
		UniqueKey string `json:"uniqueKey"`
		Value     string `json:"value"`
		OrderNum  uint64 `json:"orderNum"`
		Remark    string `json:"remark"`
		Status    uint64 `json:"status"`
	}
	ConfigDictListResp {
		DictList []ConfigDict `json:"list"`
	}
)

type (
	ConfigDictPageReq {
		Page     uint64 `form:"page"      validate:"number,gte=1"`
		Limit    uint64 `form:"limit"     validate:"number,gte=1"`
		ParentId uint64 `form:"parentId"  validate:"number,gte=0"`
	}
	ConfigDictPagination {
		Page  uint64 `json:"page"`
		Limit uint64 `json:"limit"`
		Total uint64 `json:"total"`
	}
	ConfigDictPageResp {
		ConfigDictList []ConfigDict         `json:"list"`
		Pagination     ConfigDictPagination `json:"pagination"`
	}
)

type (
	AddConfigDictReq {
		ParentId  uint64 `json:"parentId"   validate:"number,gte=0"`
		Name      string `json:"name"       validate:"min=2,max=50"`
		Type      uint64 `json:"type"       validate:"number,gte=1,lte=12"`
		UniqueKey string `json:"uniqueKey"  validate:"min=2,max=50"`
		Value     string `json:"value"      validate:"max=2048"`
		OrderNum  uint64 `json:"orderNum"   validate:"gte=0,lte=9999"`
		Remark    string `json:"remark"     validate:"max=200"`
		Status    uint64 `json:"status"     validate:"number,gte=0,lte=1"`
	}
)

type (
	DeleteConfigDictReq {
		Id uint64 `json:"id"  validate:"number,gte=1"`
	}
)

type (
	UpdateConfigDictReq {
		Id        uint64 `json:"id"        validate:"number,gte=1"`
		ParentId  uint64 `json:"parentId"  validate:"number,gte=0"`
		Name      string `json:"name"      validate:"min=2,max=50"`
		Type      uint64 `json:"type"      validate:"number,gte=1,lte=12"`
		Value     string `json:"value"     validate:"max=2048"`
		OrderNum  uint64 `json:"orderNum"  validate:"gte=0,lte=9999"`
		Remark    string `json:"remark"    validate:"max=200"`
		Status    uint64 `json:"status"    validate:"number,gte=0,lte=1"`
	}
)

@server(
	jwt: JwtAuth
	group : config/dict
	prefix : /config/dict
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "字典列表"
	)
	@handler GetConfigDictList
	get /list returns (ConfigDictListResp)
	
	@doc(
		summary: "分页字典数据"
	)
	@handler GetConfigDictPage
	get /data/page (ConfigDictPageReq) returns (ConfigDictPageResp)
	
	@doc(
		summary: "新增字典"
	)
	@handler AddConfigDict
	post /add (AddConfigDictReq)
	
	@doc(
		summary: "删除字典"
	)
	@handler DeleteConfigDict
	post /delete (DeleteConfigDictReq)
	
	@doc(
		summary: "更新字典"
	)
	@handler UpdateConfigDict
	post /update (UpdateConfigDictReq)
}

日志管理

登录日志

路径：app/core/cmd/api/desc/log/log.api

syntax = "v1"

info(
	title: "日志"
	desc: "日志"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	LogLogin {
		Id         uint64 `json:"id"`
		Account    string `json:"account"`
		Ip         string `json:"ip"`
		Uri        string `json:"uri"`
		Status     uint64 `json:"status"`
		CreateTime string `json:"createTime"`
	}
	LogLoginPageReq {
		Page  uint64 `form:"page"   validate:"number,gte=1"`
		Limit uint64 `form:"limit"  validate:"number,gte=1"`
	}
	LogLoginPagePagination {
		Page  uint64 `json:"page"`
		Limit uint64 `json:"limit"`
		Total uint64 `json:"total"`
	}
	LogLoginPageResp {
		LogLoginList []LogLogin             `json:"list"`
		Pagination   LogLoginPagePagination `json:"pagination"`
	}
)

@server(
	jwt: JwtAuth
	group : log/login
	prefix : /log/login
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "分页日志"
	)
	@handler GetLogLoginPage
	get /page (LogLoginPageReq) returns (LogLoginPageResp)
}

系统管理

部门管理

路径：app/core/cmd/api/desc/sys/dept.api

syntax = "v1"

info(
	title: "部门"
	desc: "部门"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	Dept {
		Id        uint64 `json:"id"`
		ParentId  uint64 `json:"parentId"`
		Name      string `json:"name"`
		FullName  string `json:"fullName"`
		UniqueKey string `json:"uniqueKey"`
		Type      uint64 `json:"type"`
		Status    uint64 `json:"status"`
		OrderNum  uint64 `json:"orderNum"`
		Remark    string `json:"remark"`
	}
	SysDeptListResp {
		DeptList []Dept `json:"list"`
	}
)

type (
	AddSysDeptReq {
		ParentId  uint64 `json:"parentId"   validate:"number,gte=0"`
		Name      string `json:"name"       validate:"min=2,max=50"`
		FullName  string `json:"fullName"   validate:"omitempty,min=2,max=50"`
		UniqueKey string `json:"uniqueKey"  validate:"min=2,max=50"`
		Type      uint64 `json:"type"       validate:"number,gte=1,lte=3"`
		Status    uint64 `json:"status"     validate:"number,gte=0,lte=1"`
		OrderNum  uint64 `json:"orderNum"   validate:"number,gte=0,lte=9999"`
		Remark    string `json:"remark"     validate:"max=200"`
	}
)

type (
	DeleteSysDeptReq {
		Id uint64 `json:"id"  validate:"number,gte=1"`
	}
)

type (
	UpdateSysDeptReq {
		Id        uint64 `json:"id"         validate:"number,gte=1"`
		ParentId  uint64 `json:"parentId"   validate:"number,gte=0"`
		Name      string `json:"name"       validate:"min=2,max=50"`
		FullName  string `json:"fullName"   validate:"omitempty,min=2,max=50"`
		UniqueKey string `json:"uniqueKey"  validate:"min=2,max=50"`
		Type      uint64 `json:"type"       validate:"number,gte=1,lte=3"`
		Status    uint64 `json:"status"     validate:"number,gte=0,lte=1"`
		OrderNum  uint64 `json:"orderNum"   validate:"number,gte=0,lte=9999"`
		Remark    string `json:"remark"     validate:"max=200"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/dept
	prefix : /sys/dept
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "部门列表"
	)
	@handler GetSysDeptList
	get /list returns (SysDeptListResp)
	
	@doc(
		summary: "新增部门"
	)
	@handler AddSysDept
	post /add (AddSysDeptReq)
	
	@doc(
		summary: "删除部门"
	)
	@handler DeleteSysDept
	post /delete (DeleteSysDeptReq)
	
	@doc(
		summary: "更新部门"
	)
	@handler UpdateSysDept
	post /update (UpdateSysDeptReq)
}
岗位管理

路径：app/core/cmd/api/desc/sys/job.api

syntax = "v1"

info(
	title: "岗位"
	desc: "岗位"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	Job {
		Id       uint64 `json:"id"`
		Name     string `json:"name"`
		Status   uint64 `json:"status"`
		OrderNum uint64 `json:"orderNum"`
	}
	SysJobPageReq {
		Page  uint64 `form:"page"   validate:"number,gte=1"`
		Limit uint64 `form:"limit"  validate:"number,gte=1"`
	}
	SysJobPagePagination {
		Page  uint64 `json:"page"`
		Limit uint64 `json:"limit"`
		Total uint64 `json:"total"`
	}
	SysJobPageResp {
		JobList    []Job                `json:"list"`
		Pagination SysJobPagePagination `json:"pagination"`
	}
)

type (
	AddSysJobReq {
		Name     string `json:"name"      validate:"min=2,max=50"`
		Status   uint64 `json:"status"    validate:"number,gte=0,lte=1"`
		OrderNum uint64 `json:"orderNum"  validate:"number,gte=0,lte=9999"`
	}
)

type (
	DeleteSysJobReq {
		Id uint64 `json:"id"  validate:"number,gte=1"`
	}
)

type (
	UpdateSysJobReq {
		Id       uint64 `json:"id"        validate:"number,gte=1"`
		Name     string `json:"name"      validate:"min=2,max=50"`
		Status   uint64 `json:"status"    validate:"number,gte=0,lte=1"`
		OrderNum uint64 `json:"orderNum"  validate:"number,gte=0,lte=9999"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/job
	prefix : /sys/job
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "分页岗位"
	)
	@handler GetSysJobPage
	get /page (SysJobPageReq) returns (SysJobPageResp)
	
	@doc(
		summary: "新增岗位"
	)
	@handler AddSysJob
	post /add (AddSysJobReq)
	
	@doc(
		summary: "删除岗位"
	)
	@handler DeleteSysJob
	post /delete (DeleteSysJobReq)
	
	@doc(
		summary: "更新岗位"
	)
	@handler UpdateSysJob
	post /update (UpdateSysJobReq)
}
菜单管理

路径：app/core/cmd/api/desc/sys/menu.api

syntax = "v1"

info(
	title: "权限菜单"
	desc: "权限菜单"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	PermMenu {
		Id           uint64   `json:"id"`
		ParentId     uint64   `json:"parentId"`
		Name         string   `json:"name"`
		Router       string   `json:"router"`
		Perms        []string `json:"perms"`
		Type         uint64   `json:"type"`
		Icon         string   `json:"icon"`
		OrderNum     uint64   `json:"orderNum"`
		ViewPath     string   `json:"viewPath"`
		IsShow       uint64   `json:"isShow"`
		ActiveRouter string   `json:"activeRouter"`
	    Has          uint64   `json:"has"`
	}
	SysPermMenuListResp {
		PermMenuList []PermMenu `json:"list"`
	}
)

type (
	AddSysPermMenuReq {
		ParentId     uint64   `json:"parentId"      validate:"number,gte=0"`
		Name         string   `json:"name"          validate:"min=2,max=50"`
		Router       string   `json:"router"        validate:"omitempty,max=1024"`
		Perms        []string `json:"perms"         validate:"omitempty,unique"`
		Type         uint64   `json:"type"          validate:"number,gte=0,lte=2"`
		Icon         string   `json:"icon"          validate:"omitempty,max=200"`
		OrderNum     uint64   `json:"orderNum"      validate:"number,gte=0,lte=9999"`
		ViewPath     string   `json:"viewPath"      validate:"omitempty,max=1024"`
		IsShow       uint64   `json:"isShow"        validate:"number,gte=0,lte=1"`
		ActiveRouter string   `json:"activeRouter"  validate:"omitempty,max=1024"`
	}
)

type (
	DeleteSysPermMenuReq {
		Id uint64 `json:"id"  validate:"number,gte=1"`
	}
)

type (
	UpdateSysPermMenuReq {
		Id           uint64   `json:"id"            validate:"number,gte=1"`
		ParentId     uint64   `json:"parentId"      validate:"number,gte=0"`
		Name         string   `json:"name"          validate:"min=2,max=50"`
		Router       string   `json:"router"        validate:"omitempty,max=1024"`
		Perms        []string `json:"perms"         validate:"omitempty,unique"`
		Type         uint64   `json:"type"          validate:"number,gte=0,lte=2"`
		Icon         string   `json:"icon"          validate:"omitempty,max=200"`
		OrderNum     uint64   `json:"orderNum"      validate:"number,gte=0,lte=9999"`
		ViewPath     string   `json:"viewPath"      validate:"omitempty,max=1024"`
		IsShow       uint64   `json:"isShow"        validate:"number,gte=0,lte=1"`
		ActiveRouter string   `json:"activeRouter"  validate:"omitempty,max=1024"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/menu
	prefix : /sys/perm/menu
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "权限菜单列表"
	)
	@handler GetSysPermMenuList
	get /list returns (SysPermMenuListResp)
	
	@doc(
		summary: "新增权限菜单"
	)
	@handler AddSysPermMenu
	post /add (AddSysPermMenuReq)
	
	@doc(
		summary: "删除权限菜单"
	)
	@handler DeleteSysPermMenu
	post /delete (DeleteSysPermMenuReq)
	
	@doc(
		summary: "更新权限菜单"
	)
	@handler UpdateSysPermMenu
	post /update (UpdateSysPermMenuReq)
}
职称管理

路径：app/core/cmd/api/desc/sys/profession.api

syntax = "v1"

info(
	title: "职称"
	desc: "职称"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	Profession {
		Id       uint64 `json:"id"`
		Name     string `json:"name"`
		Status   uint64 `json:"status"`
		OrderNum uint64 `json:"orderNum"`
	}
	SysProfessionPageReq {
		Page  uint64 `form:"page"   validate:"number,gte=1"`
		Limit uint64 `form:"limit"  validate:"number,gte=1"`
	}
	ProfessionPagePagination {
		Page  uint64 `json:"page"`
		Limit uint64 `json:"limit"`
		Total uint64 `json:"total"`
	}
	SysProfessionPageResp {
		ProfessionList []Profession             `json:"list"`
		Pagination     ProfessionPagePagination `json:"pagination"`
	}
)

type (
	AddSysProfessionReq {
		Name     string `json:"name"      validate:"min=2,max=50"`
		Status   uint64 `json:"status"    validate:"number,gte=0,lte=1"`
		OrderNum uint64 `json:"orderNum"  validate:"number,gte=0,lte=9999"`
	}
)

type (
	DeleteSysProfessionReq {
		Id uint64 `json:"id"  validate:"number,gte=1"`
	}
)

type (
	UpdateSysProfessionReq {
		Id       uint64 `json:"id"        validate:"number,gte=1"`
		Name     string `json:"name"      validate:"min=2,max=50"`
		Status   uint64 `json:"status"    validate:"number,gte=0,lte=1"`
		OrderNum uint64 `json:"orderNum"  validate:"number,gte=0,lte=9999"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/profession
	prefix : /sys/profession
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "分页职称"
	)
	@handler GetSysProfessionPage
	get /page (SysProfessionPageReq) returns (SysProfessionPageResp)
	
	@doc(
		summary: "新增职称"
	)
	@handler AddSysProfession
	post /add (AddSysProfessionReq)
	
	@doc(
		summary: "删除职称"
	)
	@handler DeleteSysProfession
	post /delete (DeleteSysProfessionReq)
	
	@doc(
		summary: "更新职称"
	)
	@handler UpdateSysProfession
	post /update (UpdateSysProfessionReq)
}
角色管理

路径：app/core/cmd/api/desc/sys/role.api

syntax = "v1"

info(
	title: "角色"
	desc: "角色"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	Role {
		Id          uint64   `json:"id"`
		ParentId    uint64   `json:"parentId"`
		Name        string   `json:"name"`
		UniqueKey   string   `json:"uniqueKey"`
		PermMenuIds []uint64 `json:"permMenuIds"`
		Remark      string   `json:"remark"`
		Status      uint64   `json:"status"`
		OrderNum    uint64   `json:"orderNum"`
	}
	SysRoleListResp {
		RoleList []Role `json:"list"`
	}
)

type (
	AddSysRoleReq {
		ParentId    uint64   `json:"parentId"     validate:"number,gte=0"`
		Name        string   `json:"name"         validate:"min=2,max=50"`
		UniqueKey   string   `json:"uniqueKey"    validate:"min=2,max=50"`
		PermMenuIds []uint64 `json:"permMenuIds"  validate:"omitempty,unique"`
		Remark      string   `json:"remark"       validate:"max=200"`
		Status      uint64   `json:"status"       validate:"number,gte=0,lte=1"`
		OrderNum    uint64   `json:"orderNum"     validate:"number,gte=0,lte=9999"`
	}
)

type (
	DeleteSysRoleReq {
		Id uint64 `json:"id"  validate:"number,gte=2"`
	}
)

type (
	UpdateSysRoleReq {
		Id          uint64   `json:"id"           validate:"number,gte=1"`
		ParentId    uint64   `json:"parentId"     validate:"number,gte=0"`
		UniqueKey   string   `json:"uniqueKey"    validate:"min=2,max=50"`
		Name        string   `json:"name"         validate:"min=2,max=50"`
		PermMenuIds []uint64 `json:"permMenuIds"  validate:"omitempty,unique"`
		Remark      string   `json:"remark"       validate:"max=200"`
		Status      uint64   `json:"status"       validate:"number,gte=0,lte=1"`
		OrderNum    uint64   `json:"orderNum"     validate:"number,gte=0,lte=9999"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/role
	prefix : /sys/role
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "角色列表"
	)
	@handler GetSysRoleList
	get /list returns (SysRoleListResp)
	
	@doc(
		summary: "新增角色"
	)
	@handler AddSysRole
	post /add (AddSysRoleReq)
	
	@doc(
		summary: "删除角色"
	)
	@handler DeleteSysRole
	post /delete (DeleteSysRoleReq)
	
	@doc(
		summary: "更新角色"
	)
	@handler UpdateSysRole
	post /update (UpdateSysRoleReq)
}
用户管理

路径：app/core/cmd/api/desc/sys/user.api

syntax = "v1"

info(
	title: "用户"
	desc: "用户"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	UserProfession {
		Id   uint64 `json:"id"`
		Name string `json:"name"`
	}
	UserJob {
		Id   uint64 `json:"id"`
		Name string `json:"name"`
	}
	UserDept {
		Id   uint64 `json:"id"`
		Name string `json:"name"`
	}
	UserRole {
		Id   uint64 `json:"id"`
		Name string `json:"name"`
	}
	User {
		Id         uint64         `json:"id"`
		Account    string         `json:"account"`
		Username   string         `json:"username"`
		Nickname   string         `json:"nickname"`
		Gender     uint64         `json:"gender"`
		Email      string         `json:"email"`
		Mobile     string         `json:"mobile"`
		Profession UserProfession `json:"profession"`
		Job        UserJob        `json:"job"`
		Dept       UserDept       `json:"dept"`
		Roles      []UserRole     `json:"roles"`
		Status     uint64         `json:"status"`
		OrderNum   uint64         `json:"orderNum"`
		Remark     string         `json:"remark"`
	}
	SysUserPageReq {
		Page   uint64 `form:"page"    validate:"number,gte=1"`
		Limit  uint64 `form:"limit"   validate:"number,gte=1"`
		DeptId uint64 `form:"deptId"  validate:"number,gte=0"`
	}
	UserPagePagination {
		Page  uint64 `json:"page"`
		Limit uint64 `json:"limit"`
		Total uint64 `json:"total"`
	}
	SysUserPageResp {
		UserList   []User             `json:"list"`
		Pagination UserPagePagination `json:"pagination"`
	}
)

type (
	AddSysUserReq {
		Account      string   `json:"account"       validate:"min=4,max=50"`
		Username     string   `json:"username"      validate:"min=2,max=50"`
		Nickname     string   `json:"nickname"      validate:"omitempty,min=2,max=50"`
		Gender       uint64   `json:"gender"        validate:"number,gte=0,lte=2"`
		Email        string   `json:"email"         validate:"omitempty,email"`
		Mobile       string   `json:"mobile"        validate:"omitempty,min=11"`
		ProfessionId uint64   `json:"professionId"  validate:"number,gte=1"`
		JobId        uint64   `json:"jobId"         validate:"number,gte=1"`
		DeptId       uint64   `json:"deptId"        validate:"number,gte=1"`
		RoleIds      []uint64 `json:"roleIds"       validate:"unique"`
		Status       uint64   `json:"status"        validate:"number,gte=0,lte=1"`
		OrderNum     uint64   `json:"orderNum"      validate:"number,gte=0,lte=9999"`
		Remark       string   `json:"remark"        validate:"max=200"`
	}
)

type (
	DeleteSysUserReq {
		Id uint64 `json:"id"  validate:"number,gte=2"`
	}
)

type (
	UpdateSysUserReq {
		Id           uint64   `json:"id"            validate:"number,gte=2"`
		Username     string   `json:"username"      validate:"min=2,max=50"`
		Nickname     string   `json:"nickname"      validate:"omitempty,min=2,max=50"`
		Gender       uint64   `json:"gender"        validate:"number,gte=0,lte=2"`
		Email        string   `json:"email"         validate:"omitempty,email"`
		Mobile       string   `json:"mobile"        validate:"omitempty,min=11"`
		ProfessionId uint64   `json:"professionId"  validate:"number,gte=1"`
		JobId        uint64   `json:"jobId"         validate:"number,gte=1"`
		DeptId       uint64   `json:"deptId"        validate:"number,gte=1"`
		RoleIds      []uint64 `json:"roleIds"       validate:"unique"`
		Status       uint64   `json:"status"        validate:"number,gte=0,lte=1"`
		OrderNum     uint64   `json:"orderNum"      validate:"number,gte=0,lte=9999"`
		Remark       string   `json:"remark"        validate:"max=200"`
	}
)

type (
	UpdateSysUserPasswordReq {
		Id       uint64 `json:"id"        validate:"number,gte=2"`
		Password string `json:"password"  validate:"min=6,max=12"`
	}
)

type (
	GetSysUserRdpjInfoReq {
		UserId uint64 `form:"userId"  validate:"number,gte=0"`
	}
	Rdpj {
		Id   uint64 `json:"id"`
		Name string `json:"name"`
	}
	DeptTree {
		Id       uint64 `json:"id"`
		ParentId uint64 `json:"parentId"`
		Name     string `json:"name"`
	}
	RoleTree {
		Id       uint64 `json:"id"`
		ParentId uint64 `json:"parentId"`
		Name     string `json:"name"`
	    Has      uint64 `json:"has"`
	}
	GetSysUserRdpjInfoResp {
		Role       []RoleTree `json:"role"`
		Dept       []DeptTree `json:"dept"`
		Profession []Rdpj     `json:"profession"`
		Job        []Rdpj     `json:"job"`
	}
)

@server(
	jwt: JwtAuth
	group : sys/user
	prefix : /sys/user
	middleware: PermMenuAuth
)
service core-api {
	@doc(
		summary: "分页用户"
	)
	@handler GetSysUserPage
	get /page (SysUserPageReq) returns (SysUserPageResp)
	
	@doc(
		summary: "新增用户"
	)
	@handler AddSysUser
	post /add (AddSysUserReq)
	
	@doc(
		summary: "删除用户"
	)
	@handler DeleteSysUser
	post /delete (DeleteSysUserReq)
	
	@doc(
		summary: "更新用户"
	)
	@handler UpdateSysUser
	post /update (UpdateSysUserReq)
	
	@doc(
		summary: "更新用户密码"
	)
	@handler UpdateSysUserPassword
	post /password/update (UpdateSysUserPasswordReq)
	
	@doc(
		summary: "角色部门职称岗位信息"
	)
	@handler GetSysUserRdpjInfo
	get /rdpj/info (GetSysUserRdpjInfoReq) returns (GetSysUserRdpjInfoResp)
}

用户模块

通用操作

路径：app/core/cmd/api/desc/user/user.api

syntax = "v1"

info(
	title: "个人中心"
	desc: "个人中心"
	author: "Trevor"
	email: "trevorlan@163.com"
)

type (
	LoginReq {
		CaptchaId  string `json:"captchaId"`
		VerifyCode string `json:"verifyCode"`
		Account    string `json:"account"`
		Password   string `json:"password"`
	}
	LoginResp {
		Token string `json:"token"`
	}
)

type (
	UserInfoResp {
		Username string `json:"username"`
		Avatar   string `json:"avatar"`
	}
)

type (
	UserProfileInfoResp {
		Username string `json:"username"`
		Nickname string `json:"nickname"`
		Gender   uint64 `json:"gender"`
		Email    string `json:"email"`
		Mobile   string `json:"mobile"`
		Remark   string `json:"remark"`
		Avatar   string `json:"avatar"`
	}
)

type (
	UpdateProfileReq {
		Username string `json:"username"  validate:"required,min=2,max=12"`
		Nickname string `json:"nickname"  validate:"omitempty,min=2,max=12"`
		Gender   uint64 `json:"gender"    validate:"gte=0,lte=2"`
		Email    string `json:"email"     validate:"omitempty,email"`
		Mobile   string `json:"mobile"    validate:"omitempty,len=11"`
		Avatar   string `json:"avatar"    validate:"required,url"`
	}
)

type (
	Menu {
		Id           uint64 `json:"id"`
		ParentId     uint64 `json:"parentId"`
		Name         string `json:"name"`
		Router       string `json:"router"`
		Type         uint64 `json:"type"`
		Icon         string `json:"icon"`
		OrderNum     uint64 `json:"orderNum"`
		ViewPath     string `json:"viewPath"`
		IsShow       uint64 `json:"isShow"`
		ActiveRouter string `json:"activeRouter"`
	}
	UserPermMenuResp {
		Menus []Menu   `json:"menus"`
		Perms []string `json:"perms"`
	}
)

type (
	UpdatePasswordReq {
		OldPassword string `json:"oldPassword"  validate:"min=6,max=12"`
		NewPassword string `json:"newPassword"  validate:"min=6,max=12"`
	}
)

type (
	LoginCaptchaResp {
		CaptchaId  string `json:"captchaId"`
		VerifyCode string `json:"verifyCode"`
	}
)

type (
	GenerateAvatarResp {
		AvatarUrl string `json:"avatarUrl"`
	}
)

@server(
	group : user
	prefix : /user
)
service core-api {
	@doc(
		summary: "登录"
	)
	@handler Login
	post /login (LoginReq) returns (LoginResp)
	
	@doc(
		summary: "登录验证码"
	)
	@handler GetLoginCaptcha
	get /login/captcha returns (LoginCaptchaResp)

	@doc(
		summary: "退出"
	)
	@handler Logout
	post /logout
}

@server(
	jwt: JwtAuth
	group : user
	prefix : /user
)
service core-api {
	@doc(
		summary: "登录信息"
	)
	@handler GetUserInfo
	get /info returns (UserInfoResp)
	
	@doc(
		summary: "权限菜单"
	)
	@handler GetUserPermMenu
	get /permmenu returns (UserPermMenuResp)
	
	@doc(
		summary: "用户资料"
	)
	@handler GetUserProfileInfo
	get /profile/info returns (UserProfileInfoResp)
	
	@doc(
		summary: "更新用户资料"
	)
	@handler UpdateUserProfile
	post /profile/update (UpdateProfileReq)
	
	@doc(
		summary: "更新密码"
	)
	@handler UpdateUserPassword
	post /password/update (UpdatePasswordReq)
	
	@doc(
		summary: "生成头像"
	)
	@handler GetGenerateAvatar
	get /avatar/generate returns (GenerateAvatarResp)
}

生成api

由于自定义了goctl模板，所以在使用goctl生成api时，请指定goctl模板路径为：dev/goctl

例如（在项目根目录下执行）

goctl api go -api app/core/cmd/api/core.api -dir app/core/cmd/api -home ./dev/goctl

编写业务逻辑

业务逻辑篇幅过长，详细请参考：

文档：https://docs.arklnk.com

前端：https://github.com/arklnk/ark-admin-vuenext

后端：https://github.com/arklnk/ark-admin-zero

go-zero：https://go-zero.dev/cn

演示： http://arkadmin.si-yee.com

账号密码备注
demo123456演示账号
Trevor Lan
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Admin API控制器介绍
weixin_63096446的博客
06-28 322
以上就是关于Admin API控制器的简单介绍和代码解析。AdminController提供了一系列API接口，用于管理管理员的相关操作，包括初始化超级管理员、获取管理员列表、删除管理员、保存管理员信息、管理员登录验证以及发送邮件等功能。通过合理使用注解和依赖注入，我们可以更加方便地开发和维护具有复杂逻辑和权限控制的API接口。
php apiadmin,ApiAdmin
weixin_28909503的博客
04-14 279
站在巨人的肩膀上，并不是高的表现，反而使自己变得渺小~只有吸收了巨人的营养，茁壮自己才是真正的高大！ --笔者ApiAdmin前端页面ApiAdmin3.0是一个前后端完全分离的项目，前端采用Vue构建，如需要可视化配置的请移步：ApiAdmin-WEB灵 感首先自我介绍下吧，我是一个PHP程序员，目前就职于某上市集团。我第一份工作是做微信开发的，这也是我入行以来第一次做的商业上线项目，虽然...
纯前端体验 ZR.Admin.NET后台管理系统
最新发布
2301_76903253的博客
06-18 752
体验 ZR.Admin.NET后台管理系统
Admin API系列课程之API&Admin API介绍
EDI电子数据交换 | 知行软件
12-07 282
欢迎来到EDI小课堂，一起学习、交流EDI知识，聊一聊关于EDI的那些事儿~ 你是否想通过API接口进行EDI系统与ERP系统的集成？ 或者是想通过调用API来触发知行之桥的所有功能？ 一定不要错过今天的Admin API调用教程！ 接下来小知将为大家带来上、中、下三部的专题讲解，全面介绍、演示知行Admin API调用，干货满满，可通过该集成方式来实现你的需求。 今天的教程是API三部曲的第一部，将用详细的例子为大家说明什么是API，以及Admin API的介绍。 快点击下方视频，一探究竟吧。
【MySQL精通之路】AdminAPI-使用
Anakki的博客
05-19 760
本文介绍MySQL SHELL提供的MySQL AdminAPI，使您能够，使用它们创建和，并集成。
ThinkAdmin后台开发框架 v5.0
10-22
ThinkAdmin v5 是一个基于 ThinkPHP 5.1 和 ThinkLibrary 开发的后台管理系统。我们致力于二次开发底层框架，提供完整的组件及API，基于此框架可以快速开发应用，另外项目安装及二次开发可以参考 ThinkPHP 官方文档，数据库文件摆放在项目根目录下。ThinkAdmin 非常适用快速二次开发，默认集成 微信开发组件，支持微信服务号，微信支付，支付宝支付，阿里云OSS存储，七牛云存储，本地服务器存储。注意事项 ：项目测试需要自行搭建环境导入数据库( admin_v5.sql )并修改配置( config/database.php )；若操作提示“测试系统禁止操作”等字样，需要删除演示路由配置( route/demo.php )或清空路由文件；当前版本使用 ThinkPHP 5.1.x，对 PHP 版本标注不低于 PHP 5.6，具体请阅读 ThinkPHP 官方文档；环境需开启 PATHINFO，不再支持 ThinkPHP 的 URL 兼容模式运行（源于如何优雅的展示）；
前端开发文档，涵盖系列手把手教程
04-07
通过实际案例和练习，读者可以逐步掌握前端开发的技能，理解网页的结构和交互原理，以及响应式设计和跨浏览器兼容性的方法。本教程还提供了进阶内容，如性能优化、移动端开发和前端工程化等，帮助开发者在实际项目中...
JAVA分布式优惠券系统后台 手把手实战开发
04-04
JAVA分布式优惠券系统后台 手把手实战开发 JAVA分布式优惠券系统后台 手把手实战开发
东方耀手把手教React Native实战开发
02-15
第0课0、手把手教React Native实战之开山篇_视频 第1课1、手把手教React Native实战之环境搭建_视频_Windows环境 第1课1、手把手教React Native实战之环境搭建【Mac真机】同时调试开发Android&IOS; 第2课2、手把手教...
kong系列：admin-api使用
weixin_33913332的博客
10-16 865
部署好kong之后，则需要将我们自己的接口加入到kong中管理，kong提供了比较全面的restful api，每个版本会有所不同，下面的记录基于kong v0.14.x kong的8001端口是resful admin api，服务、路由、配置都是通过这个端口进行管理，所以部署好之后页面可以直接访问localhost:8001 参考： ...
Admin.NET-next-一个完整的前后端管理系统
10-06
前段采用vue+ts语法，后端采用C#。数据库采用SQLServer。 构建整个完整管理系统。 包含代码生成，数据库生成。前端页面，后端接口等。节省80%的代码量。 小白也可直接上手。
Admin.Core:Admin后端，前后端分离的权限管理系统，集成统一认证授权，支持国内外主流数据库自由切换和动态高级查询，基于.Net开发的WebApi
04-14
一个基于.Net Core开发的权限管理系统，后续会增加更多实用的功能。 在线体验 演示地址： 文档地址： 项目下载后，直接编译运行项目 Ctrl + F5 Tips： 如果你想换数据库，修改Admin.Core项目下的 configs/dbconfig.Development.json 文件 //数据库类型 "type": 0, //连接字符串 "connectionString": ""
webrtc janus服务器调试工具 admin api 详解（一）
刘长福
11-21 2666
引言： 最近在调试janus服务器， 在外网测试的时候出现一些问题， 但是一直不清楚到底是什么地方出现问题，就一直追日志， 突然偶然的机会了解到admin api， 使用之后确实能找到不少问题， 对janus服务器的理解， 对janus服务器的调试都帮助很大。 开启Admin api Admin默认是关闭的， 打开也比较容易 1： Janus.jcfg 里 general设置块里 admin_se...
网关服务KONG(二)：admin-api使用指南
smqi的博客
05-05 4697
部署好kong之后，想要进行kong的配置管理，kong提供了比较全面的restful api，每个版本会有所不同，下面的记录基于kong v0.13.x。我们可以使用界面进行如下想要实现的动作，但这里主要讲解下使用api命令方式如何操作 Information Routes 获取kong节点的通用详细信息 查询节点信息 curl http://localhost:8001 部分返回字段...
体验部署ThinkAdmin
congra3007的博客
04-17 741
部署
Core Api API提示文档
yafei_THREE的博客
06-18 235
swagger
vue-admin-template登录功能前后端交互流程及编码
qq_41950447的博客
04-19 4599
1.vue-admin-template简介 官网https://panjiachen.github.io/vue-element-admin-site/zh/ vue-element-admin是一个后台前端解决方案，它基于vue和element-ui实现。它使用了最新的前端技术栈，内置了 i18 国际化解决方案，动态路由，权限验证，提炼了典型的业务模型，提供了丰富的功能组件，它可以帮助你快速搭建企业级中后台产品原型。相信不管你的需求是什么，本项目都能帮助到你。 总的来说，是一个已经很...
thinkadmin分页查询,遍历集合并修改数据
hanzhuhuaa的博客
02-20 88
【代码】thinkadmin分页查询,遍历集合并修改数据。
php对接海康视频教程_手把手教你php对接海康api
06-08
对接海康视频可以使用海康提供的开放平台API进行实现。以下是一个简单的PHP对接海康API的教程： 1. 注册并申请开放平台API的AppKey和AppSecret。 2. 在PHP中发送HTTP请求获取accessToken。可以使用curl库实现。示例...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值