api

Documentation

Index

• type Server
  • func New(mysql *db.MySQL) *Server
  • func (s *Server) AddLedger(c *gin.Context)
  • func (s *Server) GetLedger(c *gin.Context)
  • func (s *Server) GetLedgers(c *gin.Context)
  • func (s *Server) Ping(c *gin.Context)
  • func (s *Server) Run() error
  • func (s *Server) Shutdown() error
  • func (s *Server) SignIn(c *gin.Context)
  • func (s *Server) SignUp(c *gin.Context)
  • func (s *Server) Time(c *gin.Context)

Types

type Server

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

Server can start and stop api server.

func New

func New(mysql *db.MySQL) *Server

New returns new Server struct.

func (*Server) AddLedger

func (s *Server) AddLedger(c *gin.Context)

@Tags Ledger @Summary Add ledger @Description Adds ledger to db. @Accept json @Produce json @Param request body resource.ReqAddLedger true "Add ledger request body" @Success 201 {object} resource.ResAddLedger @Failure 400 {object} resource.ResErr @Failure 500 {object} resource.ResErr @Router /api/household-ledger/ledger [post]

func (*Server) GetLedger

func (s *Server) GetLedger(c *gin.Context)

@Tags Ledger @Summary Get ledger @Description Gets ledger with {ledger_id} from db. @Produce json @Param ledger_id path string true "ledger id" @Success 200 {object} resource.ResGetLedger @Failure 400 {object} resource.ResErr @Failure 404 {object} resource.ResErr @Failure 500 {object} resource.ResErr @Router /api/household-ledger/ledger/{ledger_id} [get]

func (*Server) GetLedgers

func (s *Server) GetLedgers(c *gin.Context)

@Tags Ledger @Summary Get ledgers @Description Gets ledgers with {user_id} from db. @Produce json @Param user_id path string true "user id" @Success 200 {object} resource.ResGetLedgers @Failure 400 {object} resource.ResErr @Failure 404 {object} resource.ResErr @Failure 500 {object} resource.ResErr @Router /api/household-ledger/ledgers/{user_id} [get]

func (*Server) Ping

func (s *Server) Ping(c *gin.Context)

@Tags Basic @Summary Ping @Description Ping @Produce json @Success 200 {string} pong @Failure 500 {object} resource.ResErr @Router /api/household-ledger/ping [get]

func (*Server) Run

func (s *Server) Run() error

Run sets CORS and all handlers and then runs api server.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown gracefully shutdowns api server.

func (*Server) SignIn

func (s *Server) SignIn(c *gin.Context)

@Tags User @Summary Sign in @Description Signs user in. @Accept json @Produce json @Param request body resource.ReqSignIn true "Sign in request body" @Success 200 {object} resource.ResSignIn @Failure 400 {object} resource.ResErr @Failure 404 {object} resource.ResErr @Failure 500 {object} resource.ResErr @Router /api/household-ledger/user/signin [post]

func (*Server) SignUp

func (s *Server) SignUp(c *gin.Context)

@Tags User @Summary Sign up @Description Signs user up. @Accept json @Produce json @Param request body resource.ReqSignUp true "Sign up request body" @Success 201 {object} resource.ResSignUp @Failure 400 {object} resource.ResErr @Failure 409 {object} resource.ResErr @Failure 500 {object} resource.ResErr @Router /api/household-ledger/user/signup [post]

func (*Server) Time

func (s *Server) Time(c *gin.Context)

@Tags Basic @Summary Time @Description Time @Produce json @Success 200 {object} resource.ResGetTime @Failure 500 {object} resource.ResErr @Router /api/household-ledger/time [get]