controller

Documentation

Index

• Constants
• type APIError
• type AccountController
  • func NewAccountController(container container.Container) AccountController
• type BookController
  • func NewBookController(container container.Container) BookController
• type CategoryController
  • func NewCategoryController(container container.Container) CategoryController
• type ErrorController
  • func NewErrorController(container container.Container) ErrorController
• type FormatController
  • func NewFormatController(container container.Container) FormatController
• type HealthController
  • func NewHealthController(container container.Container) HealthController

Constants

const (
	// API represents the group of API.
	API = "/api"
	// APIBooks represents the group of book management API.
	APIBooks = API + "/books"
	// APIBooksID represents the API to get book data using id.
	APIBooksID = APIBooks + "/:id"
	// APICategories represents the group of category management API.
	APICategories = API + "/categories"
	// APIFormats represents the group of format management API.
	APIFormats = API + "/formats"
)

const (
	// APIAccount represents the group of auth management API.
	APIAccount = API + "/auth"
	// 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 (
	// APIHealth represents the API to get the status of this application.
	APIHealth = API + "/health"
)

Types

type APIError

type APIError struct {
	Code    int
	Message string
}

APIError has a error code and a message.

type AccountController

type AccountController interface {
	GetLoginStatus(c echo.Context) error
	GetLoginAccount(c echo.Context) error
	Login(c echo.Context) error
	Logout(c echo.Context) error
}

AccountController is a controller for managing user account.

func NewAccountController

func NewAccountController(container container.Container) AccountController

NewAccountController is constructor.

type BookController

type BookController interface {
	GetBook(c echo.Context) error
	GetBookList(c echo.Context) error
	CreateBook(c echo.Context) error
	UpdateBook(c echo.Context) error
	DeleteBook(c echo.Context) error
}

BookController is a controller for managing books.

func NewBookController

func NewBookController(container container.Container) BookController

NewBookController is constructor.

type CategoryController

type CategoryController interface {
	GetCategoryList(c echo.Context) error
}

CategoryController is a controller for managing category data.

func NewCategoryController

func NewCategoryController(container container.Container) CategoryController

NewCategoryController is constructor.

type ErrorController

type ErrorController interface {
	JSONError(err error, c echo.Context)
}

ErrorController is a controller for handling errors.

func NewErrorController

func NewErrorController(container container.Container) ErrorController

NewErrorController is constructor.

type FormatController

type FormatController interface {
	GetFormatList(c echo.Context) error
}

FormatController is a controller for managing format data.

func NewFormatController

func NewFormatController(container container.Container) FormatController

NewFormatController is constructor.

type HealthController

type HealthController interface {
	GetHealthCheck(c echo.Context) error
}

HealthController is a controller returns the current status of this application.

func NewHealthController

func NewHealthController(container container.Container) HealthController

NewHealthController is constructor.