controller

Documentation

Index

• Constants
• func GetHealthCheck() echo.HandlerFunc
• func GetLoginAccount() echo.HandlerFunc
• func GetLoginStatus() echo.HandlerFunc
• func JSONErrorHandler(err error, c echo.Context)
• func PostLogin() echo.HandlerFunc
• func PostLogout() echo.HandlerFunc
• type APIError

Constants

const (
	// APIAccount represents the group of account management API.
	APIAccount = API + "/account"
	// APIAccountLoginStatus represents the API to get the status of logged in account.
	APIAccountLoginStatus = APIAccount + "/loginStatus"
	// APIAccountLoginAccount represents the API to get the logged in account.
	APIAccountLoginAccount = APIAccount + "/loginAccount"
	// APIAccountLogin represents the API to login by session authentication.
	APIAccountLogin = APIAccount + "/login"
	// APIAccountLogout represents the API to logout.
	APIAccountLogout = APIAccount + "/logout"
)

const (
	// API represents the group of API.
	API = "/api"
)

const (
	// APIHealth represents the API to get the status of this application.
	APIHealth = API + "/health"
)

Functions

func GetHealthCheck

func GetHealthCheck() echo.HandlerFunc

GetHealthCheck returns whether this application is alive or not.

func GetLoginAccount

func GetLoginAccount() echo.HandlerFunc

GetLoginAccount returns the account data of logged in user.

func GetLoginStatus

func GetLoginStatus() echo.HandlerFunc

GetLoginStatus returns the status of login.

func JSONErrorHandler

func JSONErrorHandler(err error, c echo.Context)

JSONErrorHandler is cumstomize error handler

func PostLogin

func PostLogin() echo.HandlerFunc

PostLogin is the method to login using username and password by http post.

func PostLogout

func PostLogout() echo.HandlerFunc

PostLogout is the method to logout by http post.

Types

type APIError

type APIError struct {
	Code    int
	Message string
}

APIError represents