api

README

Exit codes

• https://tldp.org/LDP/abs/html/exitcodes.html
• https://komodor.com/learn/exit-codes-in-containers-and-kubernetes-the-complete-guide/

Documentation

Index

• Constants
• Variables
• func Error(w http.ResponseWriter, err error)
• func HandleFunc(pattern string, handler http.HandlerFunc)
• func Init()
• func Response(w http.ResponseWriter, body any, contentType string)
• func ResponseJSON(w http.ResponseWriter, v any)
• func ResponsePrettyJSON(w http.ResponseWriter, v any)
• func ResponseSources(w http.ResponseWriter, sources []*Source)
• type Source

Constants

const (
	MimeJSON = "application/json"
	MimeText = "text/plain"
)

const StreamNotFound = "stream not found"

Variables

var Handler http.Handler

var Port int

Functions

func Error

func Error(w http.ResponseWriter, err error)

func HandleFunc

func HandleFunc(pattern string, handler http.HandlerFunc)

HandleFunc handle pattern with relative path: - "api/streams" => "{basepath}/api/streams" - "/streams" => "/streams"

func Init

func Init()

func Response

func Response(w http.ResponseWriter, body any, contentType string)

func ResponseJSON

func ResponseJSON(w http.ResponseWriter, v any)

ResponseJSON important always add Content-Type so go won't need to call http.DetectContentType

func ResponsePrettyJSON

func ResponsePrettyJSON(w http.ResponseWriter, v any)

func ResponseSources

func ResponseSources(w http.ResponseWriter, sources []*Source)

Types

type Source

type Source struct {
	ID       string `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	Info     string `json:"info,omitempty"`
	URL      string `json:"url,omitempty"`
	Location string `json:"location,omitempty"`
}