Awesome Go

jsend

CategoryUtilities
SubcategoryUtilities
Stars0

JSend's implementation written in Go

About jsend

JSend's implementation writen in Go(golang)

Build Status Coverage Status Go.Dev reference Go Report Card Release Downloads Chat Community

This package is an implementation of JSend specification written in Go(golang).

Installation

go get clevergo.tech/jsend

Usage

Usage is pretty simple.

// success response
jsend.Success(w, data)
// fail response
jsend.Fail(w, data)
// error response
jsend.Error(w, message)
// error response with extra code
jsend.ErrorCode(w, message, code)
// error response with extra code and data
jsend.ErrorCodeData(w, message, code, data)

It can also be integrated with web framework, such as Gin, Echo, CleverGo:

// success response
ctx.JSON(http.StatusOK, jsend.New(data))
// fail response
ctx.JSON(http.StatusOK, jsend.NewFail(data))
// error response
ctx.JSON(http.StatusOK, jsend.NewError(message, code, data))

Checkout example for details.

Error Handling

It is application responsibility to handle error.

Status Code

By default status code http.StatusOK was used implicitly, it can also be specified by the last parameter if necessary.

jsend.Success(w, data, http.StatusOK)
jsend.Fail(w, data, http.StatusForbidden)
jsend.Error(w, message, http.StatusInternalServerError)

Frequently Asked Questions

What is jsend?

jsend is a Utilities library for the Go programming language. JSend's implementation written in Go

How do I install jsend?

Install jsend with the Go module system using `go get clevergo/jsend`. Check the repository for the current installation instructions.

What category does jsend belong to?

jsend is listed under Utilities, specifically Utilities.

← Back to Utilities