feat: swagger接口文档更新1.0.8

src/modules/system/controller/sys_config.go

@@ -34,6 +34,18 @@ type SysConfigController struct {
 // 参数配置列表
 //
 // GET /list
+//
+//	@Tags			system/config
+//	@Accept			json
+//	@Produce		json
+//	@Param			configName	query		string	false	"configName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Config Information List
+//	@Description	Config Information List
+//	@Router			/system/config/list [get]
 func (s *SysConfigController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_dept.go

@@ -31,6 +31,19 @@ type SysDeptController struct {
 // 部门列表
 //
 // GET /list
+//
+//	@Tags			system/dept
+//	@Accept			json
+//	@Produce		json
+//	@Param			deptId		query		string	false	"deptId"
+//	@Param			parentId	query		string	false	"parentId"
+//	@Param			deptName	query		string	false	"deptName"
+//	@Param			status		query		string	false	"status"	Enums(0, 1)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Dept Information List
+//	@Description	Dept Information List
+//	@Router			/system/dept/list [get]
 func (s *SysDeptController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	var querys struct {

src/modules/system/controller/sys_dict_data.go

@@ -35,6 +35,18 @@ type SysDictDataController struct {
 // 字典数据列表
 //
 // GET /list
+//
+//	@Tags			system/dict/data
+//	@Accept			json
+//	@Produce		json
+//	@Param			dictLabel	query		string	false	"dictLabel"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Dictionary Data List
+//	@Description	Dictionary Data List
+//	@Router			/system/dict/data/list [get]
 func (s *SysDictDataController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_dict_type.go

@@ -34,6 +34,18 @@ type SysDictTypeController struct {
 // 字典类型列表
 //
 // GET /list
+//
+//	@Tags			system/dict/type
+//	@Accept			json
+//	@Produce		json
+//	@Param			dictName	query		string	false	"dictName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Dictionary Type List
+//	@Description	Dictionary Type List
+//	@Router			/system/dict/type/list [get]
 func (s *SysDictTypeController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_log_login.go

@@ -37,6 +37,18 @@ type SysLogLoginController struct {
 // 系统登录日志列表
 //
 // GET /list
+//
+//	@Tags			system/log/login
+//	@Accept			json
+//	@Produce		json
+//	@Param			userName	query		string	false	"userName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		System Login Log List
+//	@Description	System Login Log List
+//	@Router			/system/log/login/list [get]
 func (s *SysLogLoginController) List(c *gin.Context) {
 	querys := ctx.QueryMap(c)
 	dataScopeSQL := ctx.LoginUserToDataScopeSQL(c, "d", "u")

src/modules/system/controller/sys_log_operate.go

@@ -34,6 +34,18 @@ type SysLogOperateController struct {
 // 操作日志列表
 //
 // GET /list
+//
+//	@Tags			system/log/operate
+//	@Accept			json
+//	@Produce		json
+//	@Param			title		query		string	false	"title"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		System Operation Log List
+//	@Description	System Operation Log List
+//	@Router			/system/log/operate/list [get]
 func (s *SysLogOperateController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_menu.go

@@ -32,6 +32,17 @@ type SysMenuController struct {
 // 菜单列表
 //
 // GET /list
+//
+//	@Tags			system/menu
+//	@Accept			json
+//	@Produce		json
+//	@Param			menuName	query		string	false	"menuName"
+//	@Param			status		query		string	false	"status"	Enums(0, 1)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Menu Information List
+//	@Description	Menu Information List
+//	@Router			/system/menu/list [get]
 func (s *SysMenuController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	query := model.SysMenu{}

src/modules/system/controller/sys_post.go

@@ -35,6 +35,18 @@ type SysPostController struct {
 // 岗位列表
 //
 // GET /list
+//
+//	@Tags			system/post
+//	@Accept			json
+//	@Produce		json
+//	@Param			postName	query		string	false	"postName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Post Information List
+//	@Description	Post Information List
+//	@Router			/system/post/list [get]
 func (s *SysPostController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_profile.go

@@ -44,6 +44,15 @@ type SysProfileController struct {
 // 个人信息
 //
 // GET /
+//
+//	@Tags			system/user/profile
+//	@Accept			json
+//	@Produce		json
+//	@Success		200	{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Personal Information
+//	@Description	Personal Information
+//	@Router			/system/user/profile [get]
 func (s *SysProfileController) Info(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	loginUser, err := ctx.LoginUser(c)
@@ -86,6 +95,16 @@ func (s *SysProfileController) Info(c *gin.Context) {
 // 个人信息修改
 //
 // PUT /
+//
+//	@Tags			system/user/profile
+//	@Accept			json
+//	@Produce		json
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Personal Information Modification
+//	@Description	Personal Information Modification
+//	@Router			/system/user/profile [put]
 func (s *SysProfileController) UpdateProfile(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	var body struct {
@@ -183,6 +202,16 @@ func (s *SysProfileController) UpdateProfile(c *gin.Context) {
 // 个人重置密码
 //
 // PUT /updatePwd
+//
+//	@Tags			system/user/profile
+//	@Accept			json
+//	@Produce		json
+//	@Param			data	body		object	true	"Request Param"
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Personal Reset Password
+//	@Description	Personal Reset Password
+//	@Router			/system/user/profile/updatePwd [put]
 func (s *SysProfileController) UpdatePwd(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	var body struct {
@@ -249,6 +278,16 @@ func (s *SysProfileController) UpdatePwd(c *gin.Context) {
 // 个人头像上传
 //
 // POST /avatar
+//
+//	@Tags			system/user/profile
+//	@Accept			multipart/form-data
+//	@Produce		json
+//	@Param			file	formData	file	true	"The file to upload."
+//	@Success		200		{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Personal avatar upload
+//	@Description	Personal avatar upload
+//	@Router			/system/user/profile/avatar [post]
 func (s *SysProfileController) Avatar(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	formFile, err := c.FormFile("file")

src/modules/system/controller/sys_role.go

@@ -41,6 +41,18 @@ type SysRoleController struct {
 // 角色列表
 //
 // GET /list
+//
+//	@Tags			system/role
+//	@Accept			json
+//	@Produce		json
+//	@Param			roleName	query		string	false	"roleName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		Role Information List
+//	@Description	Role Information List
+//	@Router			/system/role/list [get]
 func (s *SysRoleController) List(c *gin.Context) {
 	language := ctx.AcceptLanguage(c)
 	querys := ctx.QueryMap(c)

src/modules/system/controller/sys_user.go

@@ -50,6 +50,18 @@ type SysUserController struct {
 // 用户信息列表
 //
 // GET /list
+//
+//	@Tags			system/user
+//	@Accept			json
+//	@Produce		json
+//	@Param			userName	query		string	false	"userName"
+//	@Param			pageNum		query		number	true	"pageNum"	default(1)
+//	@Param			pageSize	query		number	true	"pageSize"	default(10)
+//	@Success		200			{object}	object	"Response Results"
+//	@Security		ApiKeyAuth
+//	@Summary		User Information List
+//	@Description	User Information List
+//	@Router			/system/user/list [get]
 func (s *SysUserController) List(c *gin.Context) {
 	querys := ctx.QueryMap(c)
 	dataScopeSQL := ctx.LoginUserToDataScopeSQL(c, "d", "u")