response

Documentation

Index

• func NotFound(ctx *gin.Context)
• func RedirectToLogin(ctx *gin.Context, dst string)
• func Send(ctx *gin.Context, statusCode int, data interface{})
• func SendError(ctx *gin.Context, statusCode int, data interface{})
• func SendErrorWithParams(ctx *gin.Context, statusCode int, data interface{}, ...)
• func SendFile(c *gin.Context, storageDomain model.StorageDomain, path string)
• func SendInternalServerError(ctx *gin.Context)
• type Response
  • func New(ok bool, statusCode int, data interface{}) *Response
  • func NewResponse(ok bool, message any, errorParams map[string]string, statusCode int) *Response
  • func (m *Response) GetMessage() any
  • func (m *Response) IsError() bool
  • func (m *Response) Send(c *gin.Context)

Functions

func NotFound

func NotFound(ctx *gin.Context)

func RedirectToLogin

func RedirectToLogin(ctx *gin.Context, dst string)

SendNotFound directly sends a not found response

func Send

func Send(ctx *gin.Context, statusCode int, data interface{})

Send provides a shortcut to send a (potentially) successful response

func SendError

func SendError(ctx *gin.Context, statusCode int, data interface{})

SendError provides a shortcut to send an unsuccessful response

func SendErrorWithParams

func SendErrorWithParams(ctx *gin.Context, statusCode int, data interface{}, errorParams map[string]string)

SendErrorWithParams the same as above but for errors that require error parameters

func SendFile

func SendFile(c *gin.Context, storageDomain model.StorageDomain, path string)

SendFile sends file to client with caching header

func SendInternalServerError

func SendInternalServerError(ctx *gin.Context)

SendInternalServerError directly sends an internal server error response

Types

type Response

type Response struct {
	// Response payload
	// Ok if the response was successful or not
	Ok bool `json:"ok"`

	// Message the payload of the response, depending on the endpoint/response status
	Message any `json:"message"`

	// ErrorParams parameters defined if the response is not successful to help client's debugging
	ErrorParams map[string]string `json:"error_params,omitempty"`
	// contains filtered or unexported fields
}

func New

func New(ok bool, statusCode int, data interface{}) *Response

New provides a shortcut to a successful response object

func NewResponse

func NewResponse(ok bool, message any, errorParams map[string]string, statusCode int) *Response

func (*Response) GetMessage

func (m *Response) GetMessage() any

func (*Response) IsError

func (m *Response) IsError() bool

func (*Response) Send

func (m *Response) Send(c *gin.Context)