gorest

package module

v0.8.9 Latest Latest Go to latest Published: Dec 11, 2022 License: BSD-2-Clause Imports: 5 Imported by: 5

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dimonrus/gorest

Links

Open Source Insights

README ¶

gorest

Rest lib based on porterr

Documentation ¶

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ParseJsonBody ¶

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

ParseJsonBody Read json data from request body

func ResponseErrorStrategy ¶ added in v0.7.4

func ResponseErrorStrategy(response *http.Response) error

ResponseErrorStrategy Default response strategy

func Send ¶

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

Send response to client

func SendJson ¶

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

SendJson Sent json into http writer

func SendRawJson ¶ added in v0.8.4

func SendRawJson(writer http.ResponseWriter, httpCode int, data json.RawMessage)

SendRawJson send raw JSON

Types ¶

type HttpCodeMap ¶

type HttpCodeMap map[string]int

HttpCodeMap 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"`
}

JsonResponse Json response struct

func NewErrorJsonResponse ¶

func NewErrorJsonResponse(e porterr.IError) *JsonResponse

NewErrorJsonResponse New Json Response with error

func NewOkJsonResponse ¶

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

NewOkJsonResponse 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

Source Files ¶

View all Source files

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