api

package

v0.0.0-...-d475bae Latest Latest Go to latest Published: Jan 24, 2022 License: MIT Imports: 9 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

Package api is a template API for Crafting Sandbox.

This section is empty.

This section is empty.

func BadRequest(c *gin.Context)

BadRequest responds with error status code 400, Bad Request.

func Database() (*sql.DB, error)

Database creates a new database connection.

func Init(ctx Context)

Initialize server.

func InternalServerError(c *gin.Context)

InternalServerError responds with error status code 500, Internal Server Error.

func NotFound(c *gin.Context)

NotFound responds with error status code 404, Not Found.

func Ping(c *gin.Context)

Handles GET requests for /ping?ping=<queryString>.

func Render(c *gin.Context, indent bool, obj interface{})

Render applies indentation settings to response.

func SetupMySQLConfig()

SetupMySQLConfig updates mysqlConf using environment variables.

type Context struct {
	Mode string
	Port string
}

Router mode and server port info.

type Error struct {
	Code    int    `json:"code"`
	Status  string `json:"status"`
	Message string `json:"message"`
}

Error is a custom error structure.

type Route struct {
	Method   string
	Endpoint string
	Handler  gin.HandlerFunc
}

A routing model.

type Routes []Route

A collection of routes.