Documentation
¶
Index ¶
- Variables
- func ExtractParameters(ctx echo.Context) apiInterface.Parameters
- func HandleBadRequestError(msg string) error
- func HandleError(err error) error
- func HandleForbiddenError(msg string) error
- func HandleNotFoundError(msg string) error
- func HandleUnauthorizedError(msg string) error
- type PersesError
- type Toolbox
Constants ¶
This section is empty.
Variables ¶
View Source
var ( InternalError = &PersesError{message: "internal server error"} NotFoundError = &PersesError{message: "document not found"} ConflictError = &PersesError{message: "document already exists"} BadRequestError = &PersesError{message: "bad request"} ForbiddenError = &PersesError{message: "forbidden access"} )
Functions ¶
func ExtractParameters ¶ added in v0.40.0
func ExtractParameters(ctx echo.Context) apiInterface.Parameters
func HandleBadRequestError ¶ added in v0.26.0
func HandleError ¶
HandleError is translating the given error to the echoHTTPError
func HandleForbiddenError ¶ added in v0.43.0
func HandleNotFoundError ¶ added in v0.43.0
func HandleUnauthorizedError ¶ added in v0.42.0
Types ¶
type PersesError ¶
type PersesError struct {
// contains filtered or unexported fields
}
func (*PersesError) Error ¶
func (e *PersesError) Error() string
type Toolbox ¶
type Toolbox interface {
Create(ctx echo.Context, entity api.Entity) error
Update(ctx echo.Context, entity api.Entity) error
Delete(ctx echo.Context) error
Get(ctx echo.Context) error
List(ctx echo.Context, q databaseModel.Query) error
}
Toolbox is an interface that defines the different methods that can be used in the different endpoint of the API. This is a way to align the code of the different endpoint.
func NewToolBox ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dependency provides different manager that will be used to instantiate the different services and daos of the API.
|
Package dependency provides different manager that will be used to instantiate the different services and daos of the API. |
Click to show internal directories.
Click to hide internal directories.