httpjson

README

go-httpjson

This repository provides useful functions to deal with JSON requests via HTTP.

Getting Started

ValidateAndDecode

ValidateAndDecode first checks HTTP request method and header, then decodes JSON body to struct.

ValidateAndDecode returns both error and corresponded StatusCode. When validation or decode fails, the StatusCode has corresponded error code. The StatusCode can be set as a status code for a HTTP response. StatusCode is set to http.StatusOK if the both of them are success.

type User struct {
	Name string `json:"text"`
	Age int `json:"int"`
}

func handleUser(w http.ResponseWriter, r *http.Request) {
	var user User
	err, statusCode := httpjson.ValidateAndDecode(r, &user)
	if err != nil {
		log.Printf(err.Error())
		w.WriteHeader(statusCode)
		return
	}
	log.Printf("Request: %v", user)
}

WriteResponse

WriteResponse writes StatusCode and JSON body to response. It also sets Content-Type header to application/json.

type User struct {
	Name string `json:"text"`
	Age int `json:"int"`
}

func handleUser(w http.ResponseWriter, r *http.Request) {
	user := User{Name: "NAME", Age: "Age"}
	err := httpjson.WriteResponse(w, http.StatusOK, &user)
	if err != nil {
		log.Printf(err.Error())
		w.WriteHeader(http.StatusInternalServerError)
		return
	}
}

Documentation

Index

• func Decode(req *http.Request, v interface{}) error
• func Validate(req *http.Request) (error, int)
• func ValidateAndDecode(req *http.Request, v interface{}) (error, int)
• func WriteResponse(w http.ResponseWriter, statusCode int, v interface{}) error

Functions

func Decode

func Decode(req *http.Request, v interface{}) error

func Validate

func Validate(req *http.Request) (error, int)

Validate checks HTTP request method and header. Validate returns both error and corresponded StatusCode when validation fails. The StatusCode can be set as a status code for a HTTP response.

func ValidateAndDecode

func ValidateAndDecode(req *http.Request, v interface{}) (error, int)

func WriteResponse

func WriteResponse(w http.ResponseWriter, statusCode int, v interface{}) error

WriteResponse writes StatusCode and JSON body to response. It also sets Content-Type header to application/json.