services

Documentation

Index

• func Authenticate(r *http.Request) (authenticated bool, httpStatus int)
• func WriteError(w http.ResponseWriter, err error, httpStatus int)
• type Handler404
  • func (m *Handler404) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type ResponseError
• type ResponseStatus
• type ReturnData
• type Service
  • func Create(name string, port string, description string, version string) *Service
  • func (m *Service) Handler404(w http.ResponseWriter, req *http.Request)
  • func (m *Service) RegisterPath(path string, httpMethod string, f ServiceHandler, authenticate bool)
  • func (m *Service) RequestHandler(w http.ResponseWriter, r *http.Request, p httprouter.Params)
  • func (m *Service) Start()
• type ServiceHandler

Functions

func Authenticate

func Authenticate(r *http.Request) (authenticated bool, httpStatus int)

func WriteError

func WriteError(w http.ResponseWriter, err error, httpStatus int)

Types

type Handler404

type Handler404 struct{}

create a 404 handler - default content type is json

func (*Handler404) ServeHTTP

func (m *Handler404) ServeHTTP(w http.ResponseWriter, req *http.Request)

type ResponseError

type ResponseError struct {
	ErrorCode string `json:"errorCode,omitempty"`
	FieldName string `json:"fieldName,omitempty"`
	Message   string `json:"message,omitempty"`
}

type ResponseStatus

type ResponseStatus struct {
	ErrorCode string          `json:"errorCode,omitempty"`
	Message   string          `json:"message,omitempty"`
	Errors    []ResponseError `json:"errors,omitempty"`
}

type ReturnData

type ReturnData interface{}

create service handler - default content type is json

type Service

type Service struct {
	Name        string
	Description string
	Params      string
	Port        string
	Version     string
	// contains filtered or unexported fields
}

func Create

func Create(name string, port string, description string, version string) *Service

Create a new service

func (*Service) Handler404

func (m *Service) Handler404(w http.ResponseWriter, req *http.Request)

func (*Service) RegisterPath

func (m *Service) RegisterPath(path string, httpMethod string, f ServiceHandler, authenticate bool)

func (*Service) RequestHandler

func (m *Service) RequestHandler(w http.ResponseWriter, r *http.Request, p httprouter.Params)

func (*Service) Start

func (m *Service) Start()

type ServiceHandler

type ServiceHandler func(http.ResponseWriter, *http.Request, httprouter.Params) (ReturnData, error)