api

package

v0.2.0 Latest Latest Go to latest Published: Mar 25, 2024 License: MIT Imports: 10 Imported by: 6

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

View Source

const (
	ErrCodeSuccess         = 0
	ErrCodeValidation      = 1
	ErrCodeInternal        = 2
	ErrCodeTooManyRequests = 3
)

This section is empty.

func MustServe(config Config, factory RouteFactory, mws ...middlewares.Middleware)

func MustServeFromViper(factory RouteFactory, middlewares ...middlewares.Middleware)

func ResponseCsv(c *gin.Context, filename string, content [][]string)

func ResponseError(c *gin.Context, err error)

func ResponseSuccess(c *gin.Context, data interface{})

func Wrap(controller func(c *gin.Context) (interface{}, error)) gin.HandlerFunc

type BusinessError struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

func ErrInternal(err error) *BusinessError

func ErrTooManyRequests(err error) *BusinessError

func ErrValidation(err error) *BusinessError

func NewBusinessError(code int, message string, data interface{}) *BusinessError

func Success(data interface{}) *BusinessError

func (err *BusinessError) Error() string

type Config struct {
	Endpoint string `default:":12345"`

	RecoveryDisabled bool
	CorsOrigins      []string
	Logger           bool
}

type RouteFactory func(router *gin.Engine)