apixt

README

go-apixt

Extends your golang API with a secret route that simplifies development and debugging

Documentation

Index

• Constants
• Variables
• func Get(r *http.Request) *dmpTree
• func GetResolvedTemplate() (string, error)
• func NewDumpTree(r *http.Request) *dmpTree
• func NewRootNode() *rootNode
• func SplitString(input string) string
• type ApixtConfig
• type Claims
• type Credentials
• type Dmux
  • func Init(oldHandler *http.ServeMux, config ApixtConfig) *Dmux
  • func (dm *Dmux) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))
  • func (s *Dmux) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type DumpBlockNode
  • func NewDumpBlockNode(title, inner string, options blockOptions) *DumpBlockNode
• type PageData
• type SectionInfoNode
  • func NewSectionInfoNode(parent int) *SectionInfoNode
• type SectionNode
  • func NewSectionNode(title string, parent int) *SectionNode
• type Timer
  • func (t *Timer) End() int64
  • func (t *Timer) Start() int
  • func (t *Timer) Stop()
• type Timers
  • func NewTimers() *Timers

Constants

const CrownKey ctxKey = 1

const DUMP_PARAM = "dump"

const STOP_NEXT_PREFIX = "-"

Variables

var DumpBlockNodeType string = "DumpBlockNode"

var SectionInfoNodeType string = "SectionInfoNode"

var SectionNodeType string = "SectionNode"

Functions

func Get

func Get(r *http.Request) *dmpTree

func GetResolvedTemplate

func GetResolvedTemplate() (string, error)

func NewDumpTree

func NewDumpTree(r *http.Request) *dmpTree

func NewRootNode

func NewRootNode() *rootNode

func SplitString

func SplitString(input string) string

Types

type ApixtConfig

type ApixtConfig struct {
	ApiId       string        `json:"apiId"`
	Permanent   bool          `json:"permanent"`
	BaseUrl     string        `json:"-"`
	DumpPath    string        `json:"dumpPath"`
	Routes      []string      `json:"routes"`
	DumpHeader  string        `json:"dumpHeader"`
	StorePrefix string        `json:"storePrefix"`
	JwtSecret   string        `json:"-"`
	Users       []Credentials `json:"-"`
}

type Claims

type Claims struct {
	Username string `json:"username"`
	jwt.RegisteredClaims
}

type Credentials

type Credentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type Dmux

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

func Init

func Init(oldHandler *http.ServeMux, config ApixtConfig) *Dmux

func (*Dmux) HandleFunc

func (dm *Dmux) HandleFunc(pattern string, handler func(http.ResponseWriter, *http.Request))

func (*Dmux) ServeHTTP

func (s *Dmux) ServeHTTP(w http.ResponseWriter, r *http.Request)

type DumpBlockNode

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

func NewDumpBlockNode

func NewDumpBlockNode(title, inner string, options blockOptions) *DumpBlockNode

type PageData

type PageData struct {
	Title  string
	CSS    template.CSS
	JS     template.JS
	Config template.JS
}

type SectionInfoNode

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

func NewSectionInfoNode

func NewSectionInfoNode(parent int) *SectionInfoNode

type SectionNode

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

func NewSectionNode

func NewSectionNode(title string, parent int) *SectionNode

type Timer

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

func (*Timer) End

func (t *Timer) End() int64

func (*Timer) Start

func (t *Timer) Start() int

func (*Timer) Stop

func (t *Timer) Stop()

type Timers

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

func NewTimers

func NewTimers() *Timers