response

package

v0.0.6 Latest Latest Go to latest Published: Mar 14, 2020 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/BentCoder/golibrary

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Error
- func NewError() *Error
- func (e Error) Write(w http.ResponseWriter, code int, headers map[string]string)
type Success
- func NewSuccess() *Success
- func (s Success) Write(w http.ResponseWriter, code int, headers map[string]string)

Constants ¶

View Source

const (
	// MsgResourceNotFound is associated with `404` response code.
	MsgResourceNotFound = "The resource was not found."
	// MsgInternalServer is associated with `500` response code.
	MsgInternalServer = "An internal server error occurred."
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Error ¶

type Error struct {
	Operation string            `json:"operation,omitempty"`
	Message   string            `json:"message,omitempty"`
	Errors    map[string]string `json:"errors,omitempty"`
}

func NewError ¶

func NewError() *Error

NewError returns `*Error` instance.

func (Error) Write ¶

func (e Error) Write(w http.ResponseWriter, code int, headers map[string]string)

Write calls `write` function to write error response.

type Success ¶

type Success struct {
	Operation string      `json:"operation,omitempty"`
	Data      interface{} `json:"data,omitempty"`
	Meta      interface{} `json:"meta,omitempty"`
}

func NewSuccess ¶

func NewSuccess() *Success

NewSuccess returns `*Success` instance.

func (Success) Write ¶

func (s Success) Write(w http.ResponseWriter, code int, headers map[string]string)

Write calls `write` function to write success response.

Source Files ¶

View all Source files

response.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL