apiserver

package

v0.27.2 Latest Latest Go to latest Published: Apr 14, 2023 License: Apache-2.0 Imports: 11 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.

This section is empty.

This section is empty.

type APIServer struct {
	// contains filtered or unexported fields
}

APIServer APIServer

func NewAPIServer(props *APIServerProps) *APIServer

NewAPIServer NewAPIServer

func (s *APIServer) Start(routeMapping map[string]RouteHandler)

type APIServerProps struct {
	Port string
}

type Context struct {
	Res    http.ResponseWriter
	Req    *http.Request
	Safe   func()
	Params map[string]string
}

func (c *Context) Decode(ptr interface{})

func (c *Context) Error(message string)

func (c *Context) GetParam(name string) *Param

func (c *Context) GetQueryInt(name string, defaultValue int) int

func (c *Context) GetQueryString(name string, defaultValue string) string

func (c *Context) GetRequiredParam(name string) *Param

func (c *Context) SendJSON(data interface{})

func (c *Context) SendOK()

func (c *Context) Unauthorized()

type ErrorResponse struct {
	Error string `json:"error"`
}

type Param struct {
	Raw string
}

func (p *Param) AsInt() int

func (p *Param) AsInt64() int64

func (p *Param) AsString() string

type RouteHandler func(context *Context)