api

README

HTTP API

You can manage all blocks with basic HTTP API functions.

Authentication

API bearer token can be set on sdns config. If the token set, Authorization header should be send on API requests.

Example Header

Authorization: Bearer my_very_long_token

Actions

GET /api/v1/block/set/:key

It is used to create a new block.

request

curl http://localhost:8080/api/v1/block/set/domain.com

response

{"success":true}

GET /api/v1/block/get/:key

Used to request an existing block

request

curl http://localhost:8080/api/v1/block/get/domain.com

response

{"success":true}

or

{"error":"domain.com not found"}

GET /api/v1/block/exists/:key

It queries whether it has a block.

request

curl http://localhost:8080/api/v1/block/exists/domain.com

response

{"success":true}

GET /api/v1/block/remove/:key

Deletes the block.

request

curl http://localhost:8080/api/v1/block/remove/domain.com

response

{"success":true}

GET /api/v1/purge/domain/type

Purge a cached query.

request

curl http://localhost:8080/api/v1/purge/example.com/MX

response

{"success":true}

GET /metrics

Export the prometheus metrics.

Documentation

Overview

Copyright (c) 2019 Eduard Urbach

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
  • func (g *Group) GET(path string, handle Handler)
  • func (g *Group) Handle(method, path string, handle Handler)
  • func (g *Group) POST(path string, handle Handler)
• type Handler
• type Json
• type Param
• type Params
• type Router
  • func NewRouter() *Router
  • func (rt *Router) GET(path string, handle Handler)
  • func (rt *Router) Group(rp string) *Group
  • func (rt *Router) Handle(method, path string, handle Handler)
  • func (rt *Router) POST(path string, handle Handler)
  • func (rt *Router) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Tree
  • func (tree *Tree) Add(path string, data dataType)
  • func (tree *Tree) Lookup(ctx *Context)

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

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

func (*Context) JSON

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

func (*Context) Param

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

type Group

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

func (*Group) GET

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

func (*Group) Handle

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

func (*Group) POST

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

type Handler

type Handler func(ctx *Context)

type Json

type Json map[string]any

type Param

type Param struct {
	Key   string
	Value string
}

type Params

type Params []Param

type Router

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

func NewRouter

func NewRouter() *Router

func (*Router) GET

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

func (*Router) Group

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

func (*Router) Handle

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

func (*Router) POST

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

func (*Router) ServeHTTP

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

type Tree

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

Tree represents a radix tree.

func (*Tree) Add

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

Add adds a new element to the tree.

func (*Tree) Lookup

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

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