app

Documentation

Index

• type Config
  • func LoadConfig(path string) (Config, error)
  • func (conf Config) Validate() error
• type Context
  • func (c *Context) BadRequest(message string) error
  • func (c *Context) InternalServerError(err error) error
  • func (c *Context) NotFound(message string) error
  • func (c *Context) Success(v interface{}) error
  • func (c *Context) SuccessWithEmpty() error
• type Env
  • func NewEnv(conf Config) (*Env, error)
• type HandlerFunc

Types

type Config

type Config struct {
	Port uint16    `json:"port"`
	DB   db.Config `json:"db"`
}

Config for the main application.

func LoadConfig

func LoadConfig(path string) (Config, error)

LoadConfig loads the config.

func (Config) Validate

func (conf Config) Validate() error

Validate validates the config.

type Context

type Context struct {
	echo.Context
}

Context represents the context of the current HTTP request.

func (*Context) BadRequest

func (c *Context) BadRequest(message string) error

BadRequest sends an error response with status code 400.

func (*Context) InternalServerError

func (c *Context) InternalServerError(err error) error

InternalServerError sends an error response with status code 500.

func (*Context) NotFound

func (c *Context) NotFound(message string) error

NotFound sends an error response with status code 404.

func (*Context) Success

func (c *Context) Success(v interface{}) error

Success sends a JSON response with status code 200.

func (*Context) SuccessWithEmpty

func (c *Context) SuccessWithEmpty() error

SuccessWithEmpty sends an empty JSON response with status code 200.

type Env

type Env struct {
	DB     *sql.DB
	Config Config
}

Env holds some application-level objects.

func NewEnv

func NewEnv(conf Config) (*Env, error)

NewEnv creates an instance of Env.

type HandlerFunc

type HandlerFunc func(env *Env, c *Context) error

HandlerFunc is a function to serve HTTP requests.