response

package

v0.0.0-...-76f5359 Latest Latest Go to latest Published: May 7, 2024 License: MIT Imports: 6 Imported by: 0

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/best-expendables-v2/common-utils

Links

Open Source Insights

Documentation ¶

Index ¶

func RenderJson(w http.ResponseWriter, res ApiResponse)
type ApiResponse
- func (a ApiResponse) AddMetadata(m Metadata) ApiResponse
type Error
type Metadata

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RenderJson ¶

func RenderJson(w http.ResponseWriter, res ApiResponse)

Types ¶

type ApiResponse ¶

type ApiResponse struct {
	Code     int               `json:"-"`
	Data     interface{}       `json:"data,omitempty"`
	Metadata Metadata          `json:"metadata,omitempty"`
	Headers  map[string]string `json:"-"`
	Errors   interface{}       `json:"errors,omitempty"`
}

func Accepted ¶

func Accepted(data interface{}) ApiResponse

Accepted 202-Accepted with data in body

func BadRequest ¶

func BadRequest(err error) ApiResponse

BadRequest 400-Bad Request

func ConvertServiceError ¶

func ConvertServiceError(err error) ApiResponse

func CreateValidationErrResponse ¶

func CreateValidationErrResponse(errMessages []validation.ValidationError) ApiResponse

func Created ¶

func Created(data interface{}) ApiResponse

Created 201-Created with data in body

func ErrorResponse ¶

func ErrorResponse(err error, status int) ApiResponse

ErrorResponse Custom error response

func InternalServerError ¶

func InternalServerError(err error) ApiResponse

500 Internal server error

func Ok ¶

func Ok(data interface{}) ApiResponse

Ok 200-OK with data in body

func PartialContent ¶

func PartialContent(data interface{}) ApiResponse

PartialContent 206-Partial Content with data in body

func RecordNotFoundError ¶

func RecordNotFoundError(err error, message string) ApiResponse

func ValidationError ¶

func ValidationError(err error) ApiResponse

ValidationError 422-Unprocessable Enttity

func (ApiResponse) AddMetadata ¶

func (a ApiResponse) AddMetadata(m Metadata) ApiResponse

type Error ¶

type Error struct {
	Message    string                       `json:"message,omitempty"`
	Code       string                       `json:"code,omitempty"`
	StatusCode int                          `json:"status_code,omitempty"`
	Errors     []validation.ValidationError `json:"errors,omitempty"`
}

type Metadata ¶

type Metadata struct {
	Total int `json:"total,omitempty"`
}

Source Files ¶

View all Source files

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