api

Documentation

Index

• func HTTPHeadersToShellVars(h http.Header) []string
• func NewRouter(conf *config.Config) *http.ServeMux
• func Shutdown()
• func Start()
• func URLValuesToShellVars(q url.Values) []string
• type HandlerFunc
• type Info
• type Route
• type Routes

Functions

func HTTPHeadersToShellVars

func HTTPHeadersToShellVars(h http.Header) []string

HTTPHeadersToShellVars convert HTTP headers to shell vars.

func NewRouter

func NewRouter(conf *config.Config) *http.ServeMux

NewRouter creates router with declared routes

func Shutdown

func Shutdown()

Shutdown set API as stopped

func Start

func Start()

Start set API as started

func URLValuesToShellVars

func URLValuesToShellVars(q url.Values) []string

URLValuesToShellVars convert URL values to shell vars.

Types

type HandlerFunc

type HandlerFunc func(conf *config.Config) http.Handler

HandlerFunc custom function handler

type Info

type Info struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

Info API informations model structure.

type Route

type Route struct {
	Path        string
	HandlerFunc HandlerFunc
	Middlewares middleware.Middlewares
}

Route is the structure of an HTTP route definition

type Routes

type Routes []Route

Routes is a list of Route