util

package

v0.1.0 Latest Latest Go to latest Published: Jan 18, 2021 License: GPL-3.0 Imports: 8 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/dreamvo/gilfoyle

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewData(ctx *gin.Context, status int, data interface{})
func NewError(ctx *gin.Context, status int, err error)
func NewResponse(ctx *gin.Context, status int, obj interface{})
func NewValidationError(ctx *gin.Context, err error)
func ValidateBody(ctx *gin.Context, obj interface{}) error
func ValidateUUID(id string) (uuid.UUID, error)
type DataResponse
type ErrorResponse
type ValidationErrorResponse

Constants ¶

View Source

const (
	ValidationErrorCode int = 400
)

Variables ¶

This section is empty.

Functions ¶

func NewData ¶

func NewData(ctx *gin.Context, status int, data interface{})

NewData returns a new response following the DataResponse schema

func NewError ¶

func NewError(ctx *gin.Context, status int, err error)

NewError returns a new error response

func NewResponse ¶

func NewResponse(ctx *gin.Context, status int, obj interface{})

NewResponse returns a new response

func NewValidationError ¶

func NewValidationError(ctx *gin.Context, err error)

NewValidationError returns a new validation error response

func ValidateBody ¶

func ValidateBody(ctx *gin.Context, obj interface{}) error

func ValidateUUID ¶

func ValidateUUID(id string) (uuid.UUID, error)

Types ¶

type DataResponse ¶

type DataResponse struct {
	Code int         `json:"code" example:"200"`
	Data interface{} `json:"data,omitempty"`
}

DataResponse example

type ErrorResponse ¶

type ErrorResponse struct {
	Code    int    `json:"code" example:"400"`
	Message string `json:"message" example:"status bad request"`
}

ErrorResponse represents an error API response

type ValidationErrorResponse ¶

type ValidationErrorResponse struct {
	Code    int               `json:"code" example:"400"`
	Message string            `json:"message" example:"status bad request"`
	Fields  map[string]string `json:"fields"`
}

ValidationErrorResponse represents a validation error API response

Source Files ¶

View all Source files

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