api

Documentation

Index

• type Error
  • func AccessForbidden() Error
  • func NewError(err error) Error
  • func NotFound() Error
  • func Validator(err error) Error
• type Server
  • func NewServer(ctx context.Context, s *zap.SugaredLogger) *Server
  • func (s *Server) API() *echo.Group
  • func (s *Server) E() *echo.Echo
  • func (s *Server) PrintRoutes()
  • func (s *Server) Start(address string) error
  • func (s *Server) Stop() error

Types

type Error

type Error struct {
	Errors map[string]interface{} `json:"errors" yaml:"errors"`
}

func AccessForbidden

func AccessForbidden() Error

func NewError

func NewError(err error) Error

func NotFound

func NotFound() Error

func Validator

func Validator(err error) Error

type Server

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

func NewServer

func NewServer(ctx context.Context, s *zap.SugaredLogger) *Server

NewServer initializes the echo server with necessary routes and configurations.

func (*Server) API

func (s *Server) API() *echo.Group

func (*Server) E

func (s *Server) E() *echo.Echo

func (*Server) PrintRoutes

func (s *Server) PrintRoutes()

func (*Server) Start

func (s *Server) Start(address string) error

Start starts the echo server

func (*Server) Stop

func (s *Server) Stop() error