Files
go-sms-V2/internal/pkg/response/response.go
T

58 lines
1.4 KiB
Go

// Package response 统一响应封装(Day 15):
// Success/Error/Page 三入口,输出 {"code":"ISC:xxxx","msg":"...","data":...}。
package response
import (
"net/http"
"github.com/gin-gonic/gin"
"go-sms/internal/pkg/errors"
)
// Success 成功响应:200 + {"code":"ISC:000","msg":"成功","data":...}。
func Success(c *gin.Context, data any) {
c.JSON(http.StatusOK, gin.H{
"code": errors.OK.Code,
"msg": errors.OK.Msg,
"data": data,
})
}
// Error 错误响应:按错误定义的 HTTPStatus 返回
// {"code":"ISC:xxxx","msg":"中文描述"}(不带 data,验收约定格式)。
func Error(c *gin.Context, e *errors.Error) {
status := e.HTTPStatus
if status == 0 {
status = http.StatusInternalServerError
}
c.JSON(status, gin.H{
"code": e.Code,
"msg": e.Msg,
})
}
// ErrorWithMsg 错误响应(场景化消息覆盖,错误码不变)。
func ErrorWithMsg(c *gin.Context, e *errors.Error, msg string) {
status := e.HTTPStatus
if status == 0 {
status = http.StatusInternalServerError
}
c.JSON(status, gin.H{"code": e.Code, "msg": msg})
}
// Page 分页响应:200 + {"code","msg","data":{list,total,page,size}}。
func Page(c *gin.Context, list any, total int64, page, size int) {
if page <= 0 {
page = 1
}
if size <= 0 {
size = 20
}
c.JSON(http.StatusOK, gin.H{
"code": errors.OK.Code,
"msg": errors.OK.Msg,
"data": gin.H{"list": list, "total": total, "page": page, "size": size},
})
}