interfaces

Documentation

Overview

Package interfaces ... generated version: 1.6.1

Index

• func Bootstrap(p *props.ControllerProps, e *echo.Echo, middlewareList MiddlewareList, ...)
• type GetHealthCheckController
  • func NewGetHealthCheckController(cp *props.ControllerProps) *GetHealthCheckController
  • func (g *GetHealthCheckController) GetHealthCheck(_ echo.Context, _ *GetHealthCheckRequest) (res *GetHealthCheckResponse, err error)
• type GetHealthCheckRequest
• type GetHealthCheckResponse
• type IGetHealthCheckController
• type MiddlewareList
  • func (m MiddlewareList) ToMap() MiddlewareMap
• type MiddlewareMap
• type MiddlewareSet
• type Routes
  • func NewRoutes(p *props.ControllerProps, router *echo.Group, opts ...io.Writer) *Routes
  • func (r *Routes) GetHealthCheck(p *props.ControllerProps) echo.HandlerFunc

Functions

func Bootstrap

func Bootstrap(p *props.ControllerProps, e *echo.Echo, middlewareList MiddlewareList, opts ...io.Writer)

Bootstrap ...

Types

type GetHealthCheckController

type GetHealthCheckController struct {
	*props.ControllerProps
}

GetHealthCheckController ...

func NewGetHealthCheckController

func NewGetHealthCheckController(cp *props.ControllerProps) *GetHealthCheckController

NewGetHealthCheckController ...

func (*GetHealthCheckController) GetHealthCheck

func (g *GetHealthCheckController) GetHealthCheck(
	_ echo.Context, _ *GetHealthCheckRequest,
) (res *GetHealthCheckResponse, err error)

GetHealthCheck health check api controller @Summary HealthCheckAPI @Description health check api @Accept json @Produce json @Success 200 {object} GetHealthCheckResponse @Failure 400 {object} wrapper.APIError @Failure 500 {object} wrapper.APIError @Router /health_check [GET]

type GetHealthCheckRequest

type GetHealthCheckRequest struct{}

GetHealthCheckRequest - health check request

type GetHealthCheckResponse

type GetHealthCheckResponse struct {
	Status string `json:"status"`
}

GetHealthCheckResponse - health check response

type IGetHealthCheckController

type IGetHealthCheckController interface {
	GetHealthCheck(c echo.Context, req *GetHealthCheckRequest) (res *GetHealthCheckResponse, err error)
}

IGetHealthCheckController ...

type MiddlewareList

type MiddlewareList []*MiddlewareSet

MiddlewareList ...

func (MiddlewareList) ToMap

func (m MiddlewareList) ToMap() MiddlewareMap

ToMap ...

type MiddlewareMap

type MiddlewareMap map[string][]echo.MiddlewareFunc

MiddlewareMap ...

type MiddlewareSet

type MiddlewareSet struct {
	Path           string
	MiddlewareFunc []echo.MiddlewareFunc
}

MiddlewareSet ...

type Routes

type Routes struct {
	// contains filtered or unexported fields
}

Routes ...

func NewRoutes

func NewRoutes(p *props.ControllerProps, router *echo.Group, opts ...io.Writer) *Routes

NewRoutes ...

func (*Routes) GetHealthCheck

func (r *Routes) GetHealthCheck(p *props.ControllerProps) echo.HandlerFunc

GetHealthCheck ...