http

package

v1.2.0 Latest Latest Go to latest Published: Dec 21, 2023 License: GPL-3.0 Imports: 7 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

This section is empty.

View Source

var ErrUnexpected = apperr.New("unexpected_error") // Error returned when an infrastructure error occurs

func Bind[TIn any](s Server, handler func(*gin.Context, TIn) error) gin.HandlerFunc

Bind the request to the given TIn and handle errors if any by setting the appropriate status.

func Created[TOut any](s Server, ctx *gin.Context, data TOut, location string, args ...any) error

Sets the location header and the response status

func File(ctx *gin.Context, filepath string) error

Returns the file at the given path.

func HandleError(s Server, ctx *gin.Context, err error)

Handle the given non-nil error and sets the status code based on error type.

func NoContent(ctx *gin.Context) error

Mark the request has succeeded with no data.

func Ok[TOut any](ctx *gin.Context, data TOut) error

Mark the request has succeeded with the given data.

func Send(s Server, handler func(*gin.Context) error) gin.HandlerFunc

Call the given handler and handle any returned error by setting the appropriate status.

type Server interface {
	IsSecure() bool
	Logger() log.Logger
}

Tiny interface to represents needed contrat in order to use helpers provided by this package.