api

Documentation

Index

• Constants
• func HTTPParamsToShellVars[T url.Values | http.Header](params T) []string
• func NewRouter(conf *config.Config) *http.ServeMux
• func Shutdown()
• func Start()
• type HandlerFunc
• type Info
• type Route
• type Routes

Constants

const (
	DefaultBufferLength = 100
	MaxBufferLength     = 10000
	SSEContentType      = "text/event-stream"
)

Functions

func HTTPParamsToShellVars

func HTTPParamsToShellVars[T url.Values | http.Header](params T) []string

HTTPParamsToShellVars convert URL values 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

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