Skip to content

Commit 96380bd

Browse files
SliverHornSliverHorn
committed
server/api/v1层代码swagger备注错误修改及代码优化
1 parent c342e63 commit 96380bd

21 files changed

+617
-658
lines changed

‎server/api/v1/exa_breakpoint_continue.go‎

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
package v1
22

33
import (
4-
"fmt"
5-
"gin-vue-admin/global/response"
6-
resp "gin-vue-admin/model/response"
4+
"gin-vue-admin/global"
5+
"gin-vue-admin/model/response"
76
"gin-vue-admin/service"
87
"gin-vue-admin/utils"
98
"github.com/gin-gonic/gin"
9+
"go.uber.org/zap"
1010
"io/ioutil"
1111
"strconv"
1212
)
@@ -17,7 +17,7 @@ import (
1717
// @accept multipart/form-data
1818
// @Produce application/json
1919
// @Param file formData file true "an example for breakpoint resume, 断点续传示例"
20-
// @Success 200 {string} string "{"success":true,"data":{},"msg":"上传成功"}"
20+
// @Success 200 {string} string "{"success":true,"data":{},"msg":"切片创建成功"}"
2121
// @Router /fileUploadAndDownload/breakpointContinue [post]
2222
func BreakpointContinue(c *gin.Context) {
2323
fileMd5 := c.Request.FormValue("fileMd5")
@@ -27,33 +27,39 @@ func BreakpointContinue(c *gin.Context) {
2727
chunkTotal, _ := strconv.Atoi(c.Request.FormValue("chunkTotal"))
2828
_, FileHeader, err := c.Request.FormFile("file")
2929
if err != nil {
30-
response.FailWithMessage(err.Error(), c)
30+
global.GVA_LOG.Error("接收文件失败!", zap.Any("err", err))
31+
response.FailWithMessage("接收文件失败", c)
3132
return
3233
}
3334
f, err := FileHeader.Open()
3435
if err != nil {
35-
response.FailWithMessage(err.Error(), c)
36+
global.GVA_LOG.Error("文件读取失败!", zap.Any("err", err))
37+
response.FailWithMessage("文件读取失败", c)
3638
return
3739
}
3840
defer f.Close()
3941
cen, _ := ioutil.ReadAll(f)
40-
if flag := utils.CheckMd5(cen, chunkMd5); !flag {
41-
response.FailWithMessage(err.Error(), c)
42+
if !utils.CheckMd5(cen, chunkMd5) {
43+
global.GVA_LOG.Error("检查md5失败!", zap.Any("err", err))
44+
response.FailWithMessage("检查md5失败", c)
4245
return
4346
}
4447
err, file := service.FindOrCreateFile(fileMd5, fileName, chunkTotal)
4548
if err != nil {
46-
response.FailWithMessage(err.Error(), c)
49+
global.GVA_LOG.Error("查找或创建记录失败!", zap.Any("err", err))
50+
response.FailWithMessage("查找或创建记录失败", c)
4751
return
4852
}
4953
err, pathc := utils.BreakPointContinue(cen, fileName, chunkNumber, chunkTotal, fileMd5)
5054
if err != nil {
51-
response.FailWithMessage(err.Error(), c)
55+
global.GVA_LOG.Error("断点续传失败!", zap.Any("err", err))
56+
response.FailWithMessage("断点续传失败", c)
5257
return
5358
}
5459

5560
if err = service.CreateFileChunk(file.ID, pathc, chunkNumber); err != nil {
56-
response.FailWithMessage(err.Error(), c)
61+
global.GVA_LOG.Error("创建文件记录失败!", zap.Any("err", err))
62+
response.FailWithMessage("创建文件记录失败", c)
5763
return
5864
}
5965
response.OkWithMessage("切片创建成功", c)
@@ -73,14 +79,15 @@ func FindFile(c *gin.Context) {
7379
chunkTotal, _ := strconv.Atoi(c.Query("chunkTotal"))
7480
err, file := service.FindOrCreateFile(fileMd5, fileName, chunkTotal)
7581
if err != nil {
82+
global.GVA_LOG.Error("查找失败!", zap.Any("err", err))
7683
response.FailWithMessage("查找失败", c)
7784
} else {
78-
response.OkWithData(resp.FileResponse{File: file}, c)
85+
response.OkWithDetailed(response.FileResponse{File: file},"查找成功", c)
7986
}
8087
}
8188

8289
// @Tags ExaFileUploadAndDownload
83-
// @Summary 查找文件
90+
// @Summary 创建文件
8491
// @Security ApiKeyAuth
8592
// @accept multipart/form-data
8693
// @Produce application/json
@@ -92,9 +99,10 @@ func BreakpointContinueFinish(c *gin.Context) {
9299
fileName := c.Query("fileName")
93100
err, filePath := utils.MakeFile(fileName, fileMd5)
94101
if err != nil {
95-
response.FailWithDetailed(response.ERROR, resp.FilePathResponse{FilePath: filePath}, fmt.Sprintf("文件创建失败：%v", err), c)
102+
global.GVA_LOG.Error("文件创建失败!", zap.Any("err", err))
103+
response.FailWithDetailed(response.FilePathResponse{FilePath: filePath}, "文件创建失败", c)
96104
} else {
97-
response.OkDetailed(resp.FilePathResponse{FilePath: filePath}, "文件创建成功", c)
105+
response.OkWithDetailed(response.FilePathResponse{FilePath: filePath}, "文件创建成功", c)
98106
}
99107
}
100108

@@ -104,7 +112,7 @@ func BreakpointContinueFinish(c *gin.Context) {
104112
// @accept multipart/form-data
105113
// @Produce application/json
106114
// @Param file formData file true "删除缓存切片"
107-
// @Success 200 {string} string "{"success":true,"data":{},"msg":"查找成功"}"
115+
// @Success 200 {string} string "{"success":true,"data":{},"msg":"缓存切片删除成功"}"
108116
// @Router /fileUploadAndDownload/removeChunk [post]
109117
func RemoveChunk(c *gin.Context) {
110118
fileMd5 := c.Query("fileMd5")
@@ -113,8 +121,9 @@ func RemoveChunk(c *gin.Context) {
113121
err := utils.RemoveChunk(fileMd5)
114122
err = service.DeleteFileChunk(fileMd5, fileName, filePath)
115123
if err != nil {
116-
response.FailWithDetailed(response.ERROR, resp.FilePathResponse{FilePath: filePath}, fmt.Sprintf("缓存切片删除失败：%v", err), c)
124+
global.GVA_LOG.Error("缓存切片删除失败!", zap.Any("err", err))
125+
response.FailWithDetailed(response.FilePathResponse{FilePath: filePath},"缓存切片删除失败", c)
117126
} else {
118-
response.OkDetailed(resp.FilePathResponse{FilePath: filePath}, "缓存切片删除成功", c)
127+
response.OkWithDetailed(response.FilePathResponse{FilePath: filePath}, "缓存切片删除成功", c)
119128
}
120129
}

‎server/api/v1/exa_customer.go‎

Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@ package v1
22

33
import (
44
"fmt"
5-
"gin-vue-admin/global/response"
5+
"gin-vue-admin/global"
66
"gin-vue-admin/model"
77
"gin-vue-admin/model/request"
8-
resp "gin-vue-admin/model/response"
8+
"gin-vue-admin/model/response"
99
"gin-vue-admin/service"
1010
"gin-vue-admin/utils"
1111
"github.com/gin-gonic/gin"
12+
"go.uber.org/zap"
1213
)
1314

1415
// @Tags ExaCustomer
@@ -20,20 +21,17 @@ import (
2021
// @Success 200 {string} string "{"success":true,"data":{},"msg":"创建成功"}"
2122
// @Router /customer/customer [post]
2223
func CreateExaCustomer(c *gin.Context) {
23-
var cu model.ExaCustomer
24-
_ = c.ShouldBindJSON(&cu)
25-
CustomerVerify := utils.Rules{
26-
"CustomerName": {utils.NotEmpty()},
27-
"CustomerPhoneData": {utils.NotEmpty()},
28-
}
29-
if CustomerVerifyErr := utils.Verify(cu, CustomerVerify); CustomerVerifyErr != nil {
30-
response.FailWithMessage(CustomerVerifyErr.Error(), c)
24+
var customer model.ExaCustomer
25+
_ = c.ShouldBindJSON(&customer)
26+
if err := utils.Verify(customer, utils.CustomerVerify); err != nil {
27+
response.FailWithMessage(err.Error(), c)
3128
return
3229
}
33-
cu.SysUserID = getUserID(c)
34-
cu.SysUserAuthorityID = getUserAuthorityId(c)
35-
if err := service.CreateExaCustomer(cu); err != nil {
36-
response.FailWithMessage(fmt.Sprintf("删除失败：%v", err), c)
30+
customer.SysUserID = getUserID(c)
31+
customer.SysUserAuthorityID = getUserAuthorityId(c)
32+
if err := service.CreateExaCustomer(customer); err != nil {
33+
global.GVA_LOG.Error("创建失败!", zap.Any("err", err))
34+
response.FailWithMessage("创建失败", c)
3735
} else {
3836
response.OkWithMessage("创建成功", c)
3937
}
@@ -48,14 +46,15 @@ func CreateExaCustomer(c *gin.Context) {
4846
// @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
4947
// @Router /customer/customer [delete]
5048
func DeleteExaCustomer(c *gin.Context) {
51-
var cu model.ExaCustomer
52-
_ = c.ShouldBindJSON(&cu)
53-
if CustomerVerifyErr := utils.Verify(cu.GVA_MODEL, utils.Rules{"ID": {utils.NotEmpty()}}); CustomerVerifyErr != nil {
54-
response.FailWithMessage(CustomerVerifyErr.Error(), c)
49+
var customer model.ExaCustomer
50+
_ = c.ShouldBindJSON(&customer)
51+
if err := utils.Verify(customer.GVA_MODEL, utils.IdVerify); err != nil {
52+
response.FailWithMessage(err.Error(), c)
5553
return
5654
}
57-
if err := service.DeleteExaCustomer(cu); err != nil {
58-
response.FailWithMessage(fmt.Sprintf("删除失败：%v", err), c)
55+
if err := service.DeleteExaCustomer(customer); err != nil {
56+
global.GVA_LOG.Error("删除失败!", zap.Any("err", err))
57+
response.FailWithMessage("删除失败", c)
5958
} else {
6059
response.OkWithMessage("删除成功", c)
6160
}
@@ -70,22 +69,19 @@ func DeleteExaCustomer(c *gin.Context) {
7069
// @Success 200 {string} string "{"success":true,"data":{},"msg":"更新成功"}"
7170
// @Router /customer/customer [put]
7271
func UpdateExaCustomer(c *gin.Context) {
73-
var cu model.ExaCustomer
74-
_ = c.ShouldBindJSON(&cu)
75-
if IdCustomerVerifyErr := utils.Verify(cu.GVA_MODEL, utils.Rules{"ID": {utils.NotEmpty()}}); IdCustomerVerifyErr != nil {
76-
response.FailWithMessage(IdCustomerVerifyErr.Error(), c)
72+
var customer model.ExaCustomer
73+
_ = c.ShouldBindJSON(&customer)
74+
if err := utils.Verify(customer.GVA_MODEL, utils.IdVerify); err != nil {
75+
response.FailWithMessage(err.Error(), c)
7776
return
7877
}
79-
CustomerVerify := utils.Rules{
80-
"CustomerName": {utils.NotEmpty()},
81-
"CustomerPhoneData": {utils.NotEmpty()},
82-
}
83-
if CustomerVerifyErr := utils.Verify(cu, CustomerVerify); CustomerVerifyErr != nil {
84-
response.FailWithMessage(CustomerVerifyErr.Error(), c)
78+
if err := utils.Verify(customer, utils.CustomerVerify); err != nil {
79+
response.FailWithMessage(err.Error(), c)
8580
return
8681
}
87-
if err := service.UpdateExaCustomer(&cu); err != nil {
88-
response.FailWithMessage(fmt.Sprintf("更新失败：%v", err), c)
82+
if err := service.UpdateExaCustomer(&customer); err != nil {
83+
global.GVA_LOG.Error("更新失败!", zap.Any("err", err))
84+
response.FailWithMessage("更新失败!", c)
8985
} else {
9086
response.OkWithMessage("更新成功", c)
9187
}
@@ -97,47 +93,49 @@ func UpdateExaCustomer(c *gin.Context) {
9793
// @accept application/json
9894
// @Produce application/json
9995
// @Param data body model.ExaCustomer true "客户ID"
100-
// @Success 200 {string} string "{"success":true,"data":{},"msg":"操作成功"}"
96+
// @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}"
10197
// @Router /customer/customer [get]
10298
func GetExaCustomer(c *gin.Context) {
103-
var cu model.ExaCustomer
104-
_ = c.ShouldBindQuery(&cu)
105-
if IdCustomerVerifyErr := utils.Verify(cu.GVA_MODEL, utils.Rules{"ID": {utils.NotEmpty()}}); IdCustomerVerifyErr != nil {
106-
response.FailWithMessage(IdCustomerVerifyErr.Error(), c)
99+
var customer model.ExaCustomer
100+
_ = c.ShouldBindQuery(&customer)
101+
if err := utils.Verify(customer.GVA_MODEL, utils.IdVerify); err != nil {
102+
response.FailWithMessage(err.Error(), c)
107103
return
108104
}
109-
err, customer := service.GetExaCustomer(cu.ID)
105+
err, data := service.GetExaCustomer(customer.ID)
110106
if err != nil {
111-
response.FailWithMessage(fmt.Sprintf("获取失败：%v", err), c)
107+
global.GVA_LOG.Error("获取失败!", zap.Any("err", err))
108+
response.FailWithMessage("获取失败", c)
112109
} else {
113-
response.OkWithData(resp.ExaCustomerResponse{Customer: customer}, c)
110+
response.OkWithDetailed(response.ExaCustomerResponse{Customer: data}, "获取成功", c)
114111
}
115112
}
116113

117114
// @Tags ExaCustomer
118-
// @Summary 获取权限客户列表
115+
// @Summary 分页获取权限客户列表
119116
// @Security ApiKeyAuth
120117
// @accept application/json
121118
// @Produce application/json
122119
// @Param data body request.PageInfo true "页码, 每页大小"
123-
// @Success 200 {string} string "{"success":true,"data":{},"msg":"操作成功"}"
120+
// @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}"
124121
// @Router /customer/customerList [get]
125122
func GetExaCustomerList(c *gin.Context) {
126123
var pageInfo request.PageInfo
127124
_ = c.ShouldBindQuery(&pageInfo)
128-
if PageVerifyErr := utils.Verify(pageInfo, utils.CustomizeMap["PageVerify"]); PageVerifyErr != nil {
129-
response.FailWithMessage(PageVerifyErr.Error(), c)
125+
if err := utils.Verify(pageInfo, utils.PageInfoVerify); err != nil {
126+
response.FailWithMessage(err.Error(), c)
130127
return
131128
}
132129
err, customerList, total := service.GetCustomerInfoList(getUserAuthorityId(c), pageInfo)
133130
if err != nil {
131+
global.GVA_LOG.Error("获取失败!", zap.Any("err", err))
134132
response.FailWithMessage(fmt.Sprintf("获取失败：%v", err), c)
135133
} else {
136-
response.OkWithData(resp.PageResult{
134+
response.OkWithDetailed(response.PageResult{
137135
List: customerList,
138136
Total: total,
139137
Page: pageInfo.Page,
140138
PageSize: pageInfo.PageSize,
141-
}, c)
139+
}, "获取成功", c)
142140
}
143141
}

‎server/api/v1/exa_file_upload_download.go‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
package v1
22

33
import (
4-
"fmt"
5-
"gin-vue-admin/global/response"
4+
"gin-vue-admin/global"
65
"gin-vue-admin/model"
76
"gin-vue-admin/model/request"
8-
resp "gin-vue-admin/model/response"
7+
"gin-vue-admin/model/response"
98
"gin-vue-admin/service"
109
"github.com/gin-gonic/gin"
10+
"go.uber.org/zap"
1111
)
1212

1313
// @Tags ExaFileUploadAndDownload
@@ -23,29 +23,32 @@ func UploadFile(c *gin.Context) {
2323
noSave := c.DefaultQuery("noSave", "0")
2424
_, header, err := c.Request.FormFile("file")
2525
if err != nil {
26-
response.FailWithMessage(fmt.Sprintf("上传文件失败，%v", err), c)
26+
global.GVA_LOG.Error("接收文件失败!", zap.Any("err", err))
27+
response.FailWithMessage("接收文件失败", c)
2728
return
2829
}
2930
err, file = service.UploadFile(header, noSave) // 文件上传后拿到文件路径
3031
if err != nil {
31-
response.FailWithMessage(fmt.Sprintf("修改数据库链接失败，%v", err), c)
32+
global.GVA_LOG.Error("修改数据库链接失败!", zap.Any("err", err))
33+
response.FailWithMessage("修改数据库链接失败", c)
3234
return
3335
}
34-
response.OkDetailed(resp.ExaFileResponse{File: file}, "上传成功", c)
36+
response.OkWithDetailed(response.ExaFileResponse{File: file}, "上传成功", c)
3537
}
3638

3739
// @Tags ExaFileUploadAndDownload
3840
// @Summary 删除文件
3941
// @Security ApiKeyAuth
4042
// @Produce application/json
4143
// @Param data body model.ExaFileUploadAndDownload true "传入文件里面id即可"
42-
// @Success 200 {string} string "{"success":true,"data":{},"msg":"返回成功"}"
44+
// @Success 200 {string} string "{"success":true,"data":{},"msg":"删除成功"}"
4345
// @Router /fileUploadAndDownload/deleteFile [post]
4446
func DeleteFile(c *gin.Context) {
4547
var file model.ExaFileUploadAndDownload
4648
_ = c.ShouldBindJSON(&file)
4749
if err := service.DeleteFile(file); err != nil {
48-
response.FailWithMessage(fmt.Sprintf("删除失败，%v", err), c)
50+
global.GVA_LOG.Error("删除失败!", zap.Any("err", err))
51+
response.FailWithMessage("删除失败", c)
4952
return
5053
}
5154
response.OkWithMessage("删除成功", c)
@@ -56,21 +59,22 @@ func DeleteFile(c *gin.Context) {
5659
// @Security ApiKeyAuth
5760
// @accept application/json
5861
// @Produce application/json
59-
// @Param data body request.PageInfo true "分页获取文件户列表"
62+
// @Param data body request.PageInfo true "页码, 每页大小"
6063
// @Success 200 {string} string "{"success":true,"data":{},"msg":"获取成功"}"
6164
// @Router /fileUploadAndDownload/getFileList [post]
6265
func GetFileList(c *gin.Context) {
6366
var pageInfo request.PageInfo
6467
_ = c.ShouldBindJSON(&pageInfo)
6568
err, list, total := service.GetFileRecordInfoList(pageInfo)
6669
if err != nil {
67-
response.FailWithMessage(fmt.Sprintf("获取数据失败，%v", err), c)
70+
global.GVA_LOG.Error("获取失败!", zap.Any("err", err))
71+
response.FailWithMessage("获取失败", c)
6872
} else {
69-
response.OkWithData(resp.PageResult{
73+
response.OkWithDetailed(response.PageResult{
7074
List: list,
7175
Total: total,
7276
Page: pageInfo.Page,
7377
PageSize: pageInfo.PageSize,
74-
}, c)
78+
},"获取成功", c)
7579
}
7680
}

0 commit comments

Comments
 (0)