rest

Documentation

Index

• type Api
  • func NewPprofApi() Api
• type AuthenticationApi
  • func NewAuthenticationApi(service service.AuthenticationService) AuthenticationApi
• type AuthenticationRequest
• type AuthenticationResponse
• type EventChannelApi
  • func NewEventChannelApi(container service.Container) EventChannelApi
• type HealthApi
  • func NewHealthApi() HealthApi
• type HealthResponse
• type LogApi
  • func NewLogApi(container service.Container) LogApi
• type RecordApi
  • func NewRecordApi(container service.Container) RecordApi
• type RefreshTokenRequest
• type RefreshTokenResponse
• type ResourceApi
  • func NewResourceApi(container service.Container) ResourceApi
• type Router
• type Server
  • func NewServer(container service.Container, config *model.AppConfig) Server
• type ServiceCaller
  • func ServiceResponder() ServiceCaller
  • func (s ServiceCaller) Respond(result interface{}, serviceError error)
  • func (s ServiceCaller) Writer(writer http.ResponseWriter) ServiceCaller
• type Token
• type VersionApi
  • func NewVersionApi() VersionApi
• type VersionResponse

Types

type Api

type Api interface {
	ConfigureRouter(router *mux.Router)
}

func NewPprofApi

func NewPprofApi() Api

type AuthenticationApi

type AuthenticationApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewAuthenticationApi

func NewAuthenticationApi(service service.AuthenticationService) AuthenticationApi

type AuthenticationRequest

type AuthenticationRequest struct {
	Username      string `json:"username"`
	Password      string `json:"password"`
	Term          string `json:"term"`
	MinimizeToken bool   `json:"minimize"`
}

type AuthenticationResponse

type AuthenticationResponse struct {
	Token Token `json:"token"`
}

type EventChannelApi

type EventChannelApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewEventChannelApi

func NewEventChannelApi(container service.Container) EventChannelApi

type HealthApi

type HealthApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewHealthApi

func NewHealthApi() HealthApi

type HealthResponse

type HealthResponse struct {
	Status string `json:"status"`
}

type LogApi

type LogApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewLogApi

func NewLogApi(container service.Container) LogApi

type RecordApi

type RecordApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewRecordApi

func NewRecordApi(container service.Container) RecordApi

type RefreshTokenRequest

type RefreshTokenRequest struct {
	Token string `json:"token"`
	Term  string `json:"term"`
}

type RefreshTokenResponse

type RefreshTokenResponse struct {
	Token Token `json:"token"`
}

type ResourceApi

type ResourceApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewResourceApi

func NewResourceApi(container service.Container) ResourceApi

type Router

type Router interface {
	ConfigureRouter(router *mux.Router)
}

type Server

type Server interface {
	Init()
	ServeH2C(lis net.Listener)
	ServeHttp(lis net.Listener)
	ServeHttp2Tls(tls net.Listener)
}

func NewServer

func NewServer(container service.Container, config *model.AppConfig) Server

type ServiceCaller

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

func ServiceResponder

func ServiceResponder() ServiceCaller

func (ServiceCaller) Respond

func (s ServiceCaller) Respond(result interface{}, serviceError error)

func (ServiceCaller) Writer

func (s ServiceCaller) Writer(writer http.ResponseWriter) ServiceCaller

type Token

type Token struct {
	Term       string    `json:"term"`
	Content    string    `json:"content"`
	Expiration time.Time `json:"expiration"`
}

type VersionApi

type VersionApi interface {
	ConfigureRouter(r *mux.Router)
}

func NewVersionApi

func NewVersionApi() VersionApi

type VersionResponse

type VersionResponse struct {
	Version string            `json:"version"`
	Modules map[string]string `json:"modules"`
}