api

Documentation

Index

• Constants
• func NewLogger() *logrus.Logger
• func SetupRouter(server *Server) *gin.Engine
• type CreateShortURLRequest
• type Server
  • func NewServer(config *config.Config, mongoClient *mongo.Client) (*Server, error)
  • func (server *Server) CreateShortURL(ctx *gin.Context)
  • func (server *Server) DeleteShortURL(ctx *gin.Context)
  • func (server *Server) GetOriginalURL(ctx *gin.Context)
  • func (server *Server) GetURLStats(ctx *gin.Context)
  • func (server *Server) HealthCheck(ctx *gin.Context)
  • func (server *Server) Start() error
  • func (server *Server) UpdateShortURL(ctx *gin.Context)
• type UpdateShortURLRequest

Constants

const (
	ErrInvalidURL        = "invalid url format"
	ErrShortCodeRequired = "short url code is required"
	ErrShortCodeNotFound = "short url not found"
)

Functions

func NewLogger

func NewLogger() *logrus.Logger

func SetupRouter

func SetupRouter(server *Server) *gin.Engine

Types

type CreateShortURLRequest

type CreateShortURLRequest struct {
	URL string `json:"url" binding:"required,httpurl"`
}

type Server

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

func NewServer

func NewServer(config *config.Config, mongoClient *mongo.Client) (*Server, error)

func (*Server) CreateShortURL

func (server *Server) CreateShortURL(ctx *gin.Context)

func (*Server) DeleteShortURL

func (server *Server) DeleteShortURL(ctx *gin.Context)

func (*Server) GetOriginalURL

func (server *Server) GetOriginalURL(ctx *gin.Context)

func (*Server) GetURLStats

func (server *Server) GetURLStats(ctx *gin.Context)

func (*Server) HealthCheck

func (server *Server) HealthCheck(ctx *gin.Context)

func (*Server) Start

func (server *Server) Start() error

func (*Server) UpdateShortURL

func (server *Server) UpdateShortURL(ctx *gin.Context)

type UpdateShortURLRequest

type UpdateShortURLRequest struct {
	URL string `json:"url" binding:"required,httpurl"`
}