golib/gweb/resp.go

//
// resp.go
// Copyright (C) 2023 tiglog <me@tiglog.com>
//
// Distributed under terms of the MIT license.
//

package gweb

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

func RenderJson(c *Context, code int, msg string, data interface{}) {
	c.JSON(http.StatusOK, gin.H{
		"code": code,
		"msg":  msg,
		"data": data,
	})
}

// 成功时，返回的 code 为 0
func RenderOk(c *Context, data interface{}) {
	RenderJson(c, 0, "success", data)
}

// 失败时，返回的 code 为指定的 code
// 一般会比 http status code 要详细一点
func RenderFail(c *Context, code int, msg string) {
	RenderJson(c, code, msg, nil)
}

// 成功时，返回自定义消息和数据
func RenderSuccess(c *Context, msg string, data interface{}) {
	RenderJson(c, 0, msg, data)
}

func RenderClientError(c *Context, err error) {
	RenderJson(c, http.StatusBadRequest, err.Error(), nil)
}

func RenderServerError(c *Context, err error) {
	RenderJson(c, http.StatusInternalServerError, err.Error(), nil)
}

func RenderClientFail(c *Context, msg string) {
	RenderJson(c, http.StatusBadRequest, msg, nil)
}

func RenderServerFail(c *Context, msg string) {
	RenderJson(c, http.StatusInternalServerError, msg, nil)
}

// 未发现的各种情况
func RenderNotFound(c *Context, msg string) {
	RenderJson(c, http.StatusNotFound, msg, nil)
}