Documentation ¶
Index ¶
Constants ¶
View Source
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" )
View Source
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" )
View Source
const ( // APIHealth represents the API to get the status of this application. APIHealth = API + "/health" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountController ¶ added in v1.5.0
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 ¶ added in v1.5.0
func NewAccountController(container container.Container) AccountController
NewAccountController is constructor.
type BookController ¶ added in v1.5.0
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 ¶ added in v1.5.0
func NewBookController(container container.Container) BookController
NewBookController is constructor.
type CategoryController ¶ added in v1.5.2
type CategoryController interface {
GetCategoryList(c echo.Context) error
}
CategoryController is a controller for managing category data.
func NewCategoryController ¶ added in v1.5.2
func NewCategoryController(container container.Container) CategoryController
NewCategoryController is constructor.
type ErrorController ¶ added in v1.5.0
type ErrorController interface {
JSONError(err error, c echo.Context)
}
ErrorController is a controller for handling errors.
func NewErrorController ¶ added in v1.5.0
func NewErrorController(container container.Container) ErrorController
NewErrorController is constructor.
type FormatController ¶ added in v1.5.2
type FormatController interface {
GetFormatList(c echo.Context) error
}
FormatController is a controller for managing format data.
func NewFormatController ¶ added in v1.5.2
func NewFormatController(container container.Container) FormatController
NewFormatController is constructor.
type HealthController ¶ added in v1.5.0
type HealthController interface {
GetHealthCheck(c echo.Context) error
}
HealthController is a controller returns the current status of this application.
func NewHealthController ¶ added in v1.5.0
func NewHealthController(container container.Container) HealthController
NewHealthController is constructor.
Click to show internal directories.
Click to hide internal directories.