response

Documentation

Index

• Constants
• type Change
• type Core
• type Message
  • func BadRequest(message string) *Message
  • func Created(key string, results interface{}) *Message
  • func File(results string) *Message
  • func InternalServerError() *Message
  • func MethodNotAllowed() *Message
  • func NotFound(key string) *Message
  • func Ok(key string, length int, results interface{}) *Message
  • func Unauthorized(message string) *Message
• type Retrieve

Constants

const (
	TypeJSON = 0
	TypeFile = 1
)

Types

type Change

type Change struct {
	Message  string `json:"message"`
	Affected int    `json:"affected"`
}

Change Response

type Core

type Core struct {
	Message string `json:"message"`
}

Core Response

type Message

type Message struct {
	StatusCode int
	Result     interface{}
	Type       int
}

Message is the return type of all handlers

func BadRequest

func BadRequest(message string) *Message

BadRequest sends response with status code 400

func Created

func Created(
	key string,
	results interface{}) *Message

Created sends response with status code 201

func File

func File(results string) *Message

File sends response with status code 200

func InternalServerError

func InternalServerError() *Message

InternalServerError sends response with status code 500

func MethodNotAllowed

func MethodNotAllowed() *Message

MethodNotAllowed sends response with status code 405

func NotFound

func NotFound(key string) *Message

NotFound sends response with status code 404

func Ok

func Ok(
	key string,
	length int,
	results interface{}) *Message

Ok sends response with status code 200

func Unauthorized

func Unauthorized(message string) *Message

Unauthorized sends response with status code 401

type Retrieve

type Retrieve struct {
	Message string      `json:"message"`
	Results interface{} `json:"results"`
}

Retrieve Response