A Go package for handling common HTTP JSON responses.

Overview

go-respond

A Go package for handling common HTTP JSON responses.

GoDoc Build Status Coverage Status Go Report Card

Installation

go get github.com/nicklaw5/go-respond

Usage

The goal of go-respond is to take most of the grunt work out preparing your JSON response. Here's a simple example:

package main

import (
    "net/http"

    resp "github.com/nicklaw5/go-respond"
)

type User struct {
    ID    int    `json:"id"`
    Name  string `json:"name"`
    Email string `json:"email"`
}

func main() {
    http.HandleFunc("/api/users", func(w http.ResponseWriter, r *http.Request) {
        users := []User{
            {1, "Billy", "[email protected]"},
            {2, "Joan", "[email protected]"},
        }

        resp.NewResponse(w).Ok(users)
    })

    http.ListenAndServe(":8080", nil)
}

Response Methods

Response Code Method Name
200 Ok()
201 Created()
202 Accepted()
204 NoContent()
400 BadRequest()
401 Unauthorized()
403 Forbidden()
404 NotFound()
405 MethodNotAllowed()
409 Conflict()
411 LengthRequired()
412 PreconditionFailed()
413 RequestEntityTooLarge()
415 UnsupportedMediaType()
422 UnprocessableEntity()
500 InternalServerError()
501 NotImplemented()
502 BadGateway()
503 ServiceUnavailable()
504 GatewayTimeout()

See here for a complete list of HTTP responses, along with an explanation of each.

Please submit a PR if you want to add to this list. Only the most common response types have been included.

To Long, Don't Write

Sometimes you don't need to return a specific content-message but don't want the response body to be empty. In this case you can use the DefaultMessage() for responding with json containing the default message for the corresponding status code.

package main

import (
    "net/http"
    resp "github.com/nicklaw5/go-respond"
)

func main() {
    http.HandleFunc("/api/users", func(w http.ResponseWriter, r *http.Request) {
        // ...
        if !authenticated {
            resp.NewResponse(w).DefaultMessage().
                Unauthorized(nil)
        }
        // ...
    })
    http.ListenAndServe(":8080", nil)
}

Would respond with {"status":401,"message":"Unauthorized"}

Handling Errors

The best option for handling errors that may occur while marshalling the JSON response, is to use Negroni's Recovery middleware. Here's an example:

package main

import (
    "net/http"

    "github.com/urfave/negroni"
    resp "github.com/nicklaw5/go-respond"
)

type Response struct {
    Success bool `json:"success"`
}

func main() {
    mux := http.NewServeMux()
    mux.HandleFunc("/", func(w http.ResponseWriter, req *http.Request) {
        resp.NewResponse(w).Ok(&Response{true})
    })

    n := negroni.New()
    recovery := negroni.NewRecovery()
    recovery.ErrorHandlerFunc = func(error interface{}) {
        // do something with the unexpected error
    }

    n.Use(recovery)
    n.UseHandler(mux)

    http.ListenAndServe(":8080", n)
}

License

This package is distributed under the terms of the MIT License.

Issues
  • Add a method for the 406 Not Acceptable HTTP code

    Add a method for the 406 Not Acceptable HTTP code

    We are using this package in our organisation and we saw that the HTTP 406 Not Acceptable code does not have its own handy method. This pull request aims to introduce one.

    opened by georgizhivankin 6
  • Don't use a separate package for tests

    Don't use a separate package for tests

    If you're using Go modules outside of the GOPATH and attempt to run the tests, the package cannot be found. This is due to the way Go Modules attempts to resolve the namespace for which the module belongs to.

    opened by nicklaw5 2
  • Add methods for http statuses: 502, 503 and 504

    Add methods for http statuses: 502, 503 and 504

    This PR includes three new methods for statuses: 502, 503 and 504. I've also reworked code of unit test to table driven style but I haven't changed old code and used only for newly added methods to make this PR minimal and easy to review and merge.

    opened by adamwasila 1
Releases(v1.6.0)
Owner
Nick Law
Software & DevOps Engineer - Go, PHP, Node, JavaScript, TypeScript, MySQL, PostgreSQL, AWS and anything cloud hosted.
Nick Law
Package json implements encoding and decoding of JSON as defined in RFC 7159

Package json implements encoding and decoding of JSON as defined in RFC 7159. The mapping between JSON and Go values is described in the documentation for the Marshal and Unmarshal functions

High Performance, Kubernetes Native Object Storage 3 May 10, 2022
JSON Spanner - A Go package that provides a fast and simple way to filter or transform a json document

JSON SPANNER JSON Spanner is a Go package that provides a fast and simple way to

null 3 Jun 30, 2022
Get JSON values quickly - JSON parser for Go

get json values quickly GJSON is a Go package that provides a fast and simple way to get values from a json document. It has features such as one line

Josh Baker 10.5k Jun 30, 2022
JSON diff library for Go based on RFC6902 (JSON Patch)

jsondiff jsondiff is a Go package for computing the diff between two JSON documents as a series of RFC6902 (JSON Patch) operations, which is particula

William Poussier 172 Jun 23, 2022
Fast JSON encoder/decoder compatible with encoding/json for Go

Fast JSON encoder/decoder compatible with encoding/json for Go

Masaaki Goshima 1.6k Jun 26, 2022
Json-go - CLI to convert JSON to go and vice versa

Json To Go Struct CLI Install Go version 1.17 go install github.com/samit22/js

Samit Ghimire 5 Mar 3, 2022
A simple Go package to Query over JSON/YAML/XML/CSV Data

A simple Go package to Query over JSON Data. It provides simple, elegant and fast ODM like API to access, query JSON document Installation Install the

Saddam H 1.9k Jun 22, 2022
a Go package to interact with arbitrary JSON

go-simplejson a Go package to interact with arbitrary JSON Importing import github.com/bitly/go-simplejson Documentation Visit the docs on Go package

Bitly 3.6k Jun 24, 2022
vjson is a Go package that helps to validate JSON objects in a declarative way.

vjson vjson is a Go package that helps to validate JSON objects in a declarative way. Getting Started Installing For installing vjson, use command bel

Milad Ebrahimi 30 May 27, 2022
jsonc is a Go package that converts the jsonc format to standard json.

jsonc jsonc is a Go package that converts the jsonc format to standard json. The jsonc format is like standard json but allows for comments and traili

Josh Baker 60 May 20, 2022
JSONata in Go Package jsonata is a query and transformation language for JSON

JSONata in Go Package jsonata is a query and transformation language for JSON. It's a Go port of the JavaScript library JSONata.

Blues Inc 25 May 27, 2022
A very rudimentary JSON compare package in GO

simple_json_compare A very rudimentary JSON compare package Sample code package main import ( "fmt" "github.com/CalypsoSys/simple_json_compare" )

Joe 0 Oct 20, 2021
A Go package to interact with arbitrary JSON

go-simplejson a Go package to interact with arbitrary JSON Importing import github.com/bitly/go-simplejson Documentation Visit the docs on Go package

LYF 0 Oct 20, 2021
This is an experimental package for working with JSON-LD documents in Go

JSON-LD ?? Simple JSON-LD in Go This is an experimental package for working with JSON-LD documents in Go. Experimental, Pre-Alpha Quality Please do no

null 3 Feb 22, 2022
Abstract JSON for golang with JSONPath support

Abstract JSON Abstract JSON is a small golang package provides a parser for JSON with support of JSONPath, in case when you are not sure in its struct

Stepan Pyzhov 119 Jun 24, 2022
Fast JSON parser and validator for Go. No custom structs, no code generation, no reflection

fastjson - fast JSON parser and validator for Go Features Fast. As usual, up to 15x faster than the standard encoding/json. See benchmarks. Parses arb

Aliaksandr Valialkin 1.6k Jun 21, 2022
Small utility to create JSON objects

gjo Small utility to create JSON objects. This was inspired by jpmens/jo. Support OS Mac Linux Windows Requirements Go 1.1.14~ Git Installtion Build $

skanehira 108 Apr 27, 2022
JSON query in Golang

gojq JSON query in Golang. Install go get -u github.com/elgs/gojq This library serves three purposes: makes parsing JSON configuration file much easie

Qian Chen 182 Apr 27, 2022
Automatically generate Go (golang) struct definitions from example JSON

gojson gojson generates go struct definitions from json or yaml documents. Example $ curl -s https://api.github.com/repos/chimeracoder/gojson | gojson

Aditya Mukerjee 2.5k Jun 23, 2022