response

Documentation

Overview

Package response handles utilities for writing error and normal responses to the response writer

Index

• func Write(res http.ResponseWriter, payload Message)
• func WriteError(res http.ResponseWriter, err Error, code int)
• type Error
• type Message

Functions

func Write

func Write(res http.ResponseWriter, payload Message)

Write will write the response to the response writer payload is any json serializable object

func WriteError

func WriteError(res http.ResponseWriter, err Error, code int)

WriteError will write to the error response to the response writer

Types

type Error

type Error struct {
	//Err is the error happened in string format
	Err string `json:"error"`
}

Error is the datastructure for writing error response

type Message

type Message struct {
	//Message associated with
	Message string
	//Data is payload
	Data interface{}
}

Message is the message to be given for successfull response