api

Documentation

Index

• Constants
• Variables
• func RegisterRoutes(mux *http.ServeMux, service *hub.Service)
• type App
  • func (a *App) GetRoutes() []rooter.Route

Constants

const (
	RouteServerStatus = "/api/server/status"
	RouteServerSetup  = "/api/server/setup"
	RouteUserMe       = "/api/user/me"
	RouteUserLogin    = "/api/user/login"
	RouteUserLogout   = "/api/user/logout"
	RouteUserNew      = "/api/user/new"
	RouteUserList     = "/api/user/list"
	RouteUserDelete   = "/api/user/delete"
	RouteUserUpdate   = "/api/user/update"
	RouteFavicon      = "/favicon.svg"
)

Route Names

Variables

var (
	ResponseServerAlreadySetup = rooter.Response{
		StatusCode: http.StatusOK,
		Message:    "Server Is Already Setup",
		State:      false,
	}
	ResponseMissingValidSession = rooter.Response{
		StatusCode: http.StatusOK,
		Message:    "Missing Valid Session",
		State:      false,
	}
	ResponseInvalidLogin = rooter.Response{
		StatusCode: http.StatusOK,
		State:      false,
		Message:    "Invlaid Login",
	}
	ResponseRecordNotFound = rooter.Response{
		StatusCode: http.StatusOK,
		State:      false,
		Message:    "Record Not Found",
	}
)

Responses

var (
	ErrUnauthorized = errors.New("unauthorized")
)

Errors

Functions

func RegisterRoutes

func RegisterRoutes(mux *http.ServeMux, service *hub.Service)

RegisterRoutes for the API

Types

type App

type App struct {
	Service *hub.Service
}

App for the REST API

func (*App) GetRoutes

func (a *App) GetRoutes() []rooter.Route

GetRoutes gets all the routes