api

package module

v0.2.0 Latest Latest Go to latest Published: Mar 25, 2023 License: MIT Imports: 1 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

TBD

TBD

TBD

TBD

TBD

TBD

Package api implements an API auxiliary functionalities.

View Source

const (
	// EnvID defines the slate.api package base environment variable name.
	EnvID = slate.EnvID + "_API"
)

View Source

const (
	// ID defines a base id of all other api
	// package instances registered in the application container.
	ID = slate.ID + ".api"
)

This section is empty.

This section is empty.

This section is empty.

Path	Synopsis
cache Package cache defines caching interaction functionalities.	Package cache defines caching interaction functionalities.
envelope Package envelope implements the response standard structure for all the REST responses providing a normalized way to provide information.	Package envelope implements the response standard structure for all the REST responses providing a normalized way to provide information.
rest Package rest implements a REST application and auxiliary.	Package rest implements a REST application and auxiliary.
envelopemw Package envelopemw implements Gin-Gonic middleware to be used as a way to guarantee the response normalization throw the envelope defined structure.	Package envelopemw implements Gin-Gonic middleware to be used as a way to guarantee the response normalization throw the envelope defined structure.
logmw Package logmw implements Gin-Gonic middleware to be used as a way to provide a REST logging normalized process.	Package logmw implements Gin-Gonic middleware to be used as a way to provide a REST logging normalized process.
validation Package validation implements structure validation parsing functionalities so that a normalized envelope can be obtained while validation the structure content.	Package validation implements structure validation parsing functionalities so that a normalized envelope can be obtained while validation the structure content.