gorest

README

gorest

Rest lib based on porterr

Documentation

Index

• func ParseJsonBody(r io.ReadCloser, data interface{}) porterr.IError
• func Send(writer http.ResponseWriter, response *JsonResponse)
• func SendJson(writer http.ResponseWriter, httpCode int, data interface{})
• type HttpCodeMap
• type JsonResponse
  • func NewErrorJsonResponse(e porterr.IError) *JsonResponse
  • func NewOkJsonResponse(message interface{}, data interface{}, meta interface{}) *JsonResponse
• type Meta

Functions

func ParseJsonBody

func ParseJsonBody(r io.ReadCloser, data interface{}) porterr.IError

Прочитать тело дескриптор запроса

func Send

func Send(writer http.ResponseWriter, response *JsonResponse)

Send response to client

func SendJson

func SendJson(writer http.ResponseWriter, httpCode int, data interface{})

Sent json into http writer

Types

type HttpCodeMap

type HttpCodeMap map[string]int

Type for http code mapping

type JsonResponse

type JsonResponse struct {
	// HTTP code
	HttpCode int `json:"-"`
	// Message information
	Message interface{} `json:"message,omitempty"`
	// Body
	Data interface{} `json:"data,omitempty"`
	// Meta information
	Meta interface{} `json:"meta,omitempty"`
	// Error information
	Error interface{} `json:"error,omitempty"`
}

Json response struct

func NewErrorJsonResponse

func NewErrorJsonResponse(e porterr.IError) *JsonResponse

New Json Response with error

func NewOkJsonResponse

func NewOkJsonResponse(message interface{}, data interface{}, meta interface{}) *JsonResponse

New Json Response without error

type Meta

type Meta struct {
	// Current page
	Page int `json:"page,omitempty"`
	// Limit
	Limit int `json:"limit,omitempty"`
	// Total count
	Total int `json:"total,omitempty"`
}

Meta information for pagination