api

package

v1.3.6 Latest Latest Go to latest Published: Jan 2, 2024 License: MIT Imports: 18 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

Repository

github.com/semihalev/sdns

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

type API
- func New(cfg *config.Config) *API
- func (a *API) Run(ctx context.Context)
type Context
- func (ctx *Context) JSON(code int, data any)
- func (ctx *Context) Param(key string) string
type Group
type Handler
type Json
type Param
type Params
type Router
- func NewRouter() *Router
type Tree
- func (tree *Tree) Add(path string, data dataType)
- func (tree *Tree) Lookup(ctx *Context)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

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

API type

func New ¶

func New(cfg *config.Config) *API

New return new api

func (*API) Run ¶

func (a *API) Run(ctx context.Context)

Run API server

type Context ¶ added in v1.3.2

type Context struct {
	Request *http.Request
	Writer  http.ResponseWriter
	Handler Handler
	Params  *Params
}

func (*Context) JSON ¶ added in v1.3.2

func (ctx *Context) JSON(code int, data any)

func (*Context) Param ¶ added in v1.3.2

func (ctx *Context) Param(key string) string

type Group ¶ added in v1.3.2

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

func (*Group) GET ¶ added in v1.3.2

func (g *Group) GET(path string, handle Handler)

func (*Group) Handle ¶ added in v1.3.2

func (g *Group) Handle(method, path string, handle Handler)

func (*Group) POST ¶ added in v1.3.2

func (g *Group) POST(path string, handle Handler)

type Handler ¶ added in v1.3.2

type Handler func(ctx *Context)

type Json ¶ added in v1.3.2

type Json map[string]any

type Param ¶ added in v1.3.2

type Param struct {
	Key   string
	Value string
}

type Params ¶ added in v1.3.2

type Params []Param

type Router ¶ added in v1.3.2

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

func NewRouter ¶ added in v1.3.2

func NewRouter() *Router

func (*Router) GET ¶ added in v1.3.2

func (rt *Router) GET(path string, handle Handler)

func (*Router) Group ¶ added in v1.3.2

func (rt *Router) Group(rp string) *Group

func (*Router) Handle ¶ added in v1.3.2

func (rt *Router) Handle(method, path string, handle Handler)

func (*Router) POST ¶ added in v1.3.2

func (rt *Router) POST(path string, handle Handler)

func (*Router) ServeHTTP ¶ added in v1.3.2

func (rt *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Tree ¶ added in v1.3.2

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

Tree represents a radix tree.

func (*Tree) Add ¶ added in v1.3.2

func (tree *Tree) Add(path string, data dataType)

Add adds a new element to the tree.

func (*Tree) Lookup ¶ added in v1.3.2

func (tree *Tree) Lookup(ctx *Context)

Lookup finds the data for the request path and assigns it to ctx.Handler, if available.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL