hap

Documentation

Index

• func Register(a API, mx ...*http.ServeMux)
• func Reply(code int) *reply
• func WithGlobalActions(as ...Action)
• type API
• type Action
  • func AllowRemoteFrom(forwarded bool, ipn ...*net.IPNet) Action
  • func GlocalActions() []Action
• type ApiSpec
  • func Specs() []ApiSpec
• type ParamSpec
• type ReplySpec

Functions

func Register

func Register(a API, mx ...*http.ServeMux)

func Reply

func Reply(code int) *reply

func WithGlobalActions

func WithGlobalActions(as ...Action)

Types

type API

type API interface {
	Endpoint() string
	Spec() []ApiSpec
	http.Handler
}

type Action

type Action func(*arg.Args, http.ResponseWriter, *http.Request) any

func AllowRemoteFrom

func AllowRemoteFrom(forwarded bool, ipn ...*net.IPNet) Action

func GlocalActions

func GlocalActions() []Action

type ApiSpec

type ApiSpec struct {
	Endpoint string      `json:"endpoint"`
	Method   string      `json:"method"`
	Help     string      `json:"help,omitempty"`
	Params   []ParamSpec `json:"params,omitempty"`
	Output   []ReplySpec `json:"output,omitempty"`
}

func Specs

func Specs() []ApiSpec

type ParamSpec

type ParamSpec struct {
	Name     string   `json:"name"`
	Type     string   `json:"type"`
	Required bool     `json:"required"`
	Default  string   `json:"default"`
	Rules    []string `json:"rules,omitempty"`
	Help     string   `json:"help,omitempty"`
}

type ReplySpec

type ReplySpec = *reply