router

Documentation

Index

• Constants
• Variables
• func Bearer(tok string) string
• func New(opts ...Option) *gin.Engine
• func NewDefault(t *testing.T, db *gorm.DB) (expect *httpexpect.Expect, closeFunc func())
• type Option
  • func WithController(c *controller.Controller) Option
  • func WithEngine(e *gin.Engine) Option
• type Result
  • func InternalServerError(err error) Result
  • func SucceedResult(msg string) Result
• type Router
  • func (r *Router) Authorize(ctx *gin.Context)
  • func (r *Router) Challenge(ctx *gin.Context)
  • func (r *Router) GetLogByDate(ctx *gin.Context)
  • func (r *Router) GetLogByUser(ctx *gin.Context)
  • func (r *Router) GetLogs(ctx *gin.Context)
  • func (r *Router) Login(ctx *gin.Context)
  • func (r *Router) Register(ctx *gin.Context)
  • func (r *Router) UpdatePassword(ctx *gin.Context)
  • func (r *Router) UserByUsername(ctx *gin.Context)
  • func (r *Router) UsernameByUUID(ctx *gin.Context)
• type Token

Constants

const (
	UsernameParam = "username"
	UUIDParam     = "uuid"
)

const (
	RootRoute                     = "/"
	EchoRoute                     = "/echo"
	LoginRoute                    = "/login"
	RegisterRoute                 = "/register"
	ChallengeRoute                = "/challenge"
	AccountPasswordRoute          = "/account/password"
	LogsRoute                     = "/logs"
	UserRoute                     = "/user"
	LogsUserRoute                 = LogsRoute + UserRoute
	DateRoute                     = "/date"
	LogsDateRoute                 = LogsRoute + DateRoute
	UserUUIDRoute                 = "/user/uuid"
	UserUUIDWithParamsRoute       = UserUUIDRoute + "/:" + UsernameParam
	UsernameByUUIDRoute           = "/user/username"
	UsernameByUUIDWithParamsRoute = UsernameByUUIDRoute + "/:" + UUIDParam
)

const (
	AuthorizationHeader = "Authorization"
)

const (
	SessionVariale = "SESSION"
)

Variables

var UnauthorizedResult = Result{Succeed: false, Message: "unauthorized"}

Functions

func Bearer

func Bearer(tok string) string

func New

func New(opts ...Option) *gin.Engine

func NewDefault

func NewDefault(t *testing.T, db *gorm.DB) (expect *httpexpect.Expect, closeFunc func())

Types

type Option

type Option func(r *Router)

func WithController

func WithController(c *controller.Controller) Option

func WithEngine

func WithEngine(e *gin.Engine) Option

type Result

type Result struct {
	Succeed bool   `json:"succeed"`
	Message string `json:"msg"`
}

func InternalServerError

func InternalServerError(err error) Result

func SucceedResult

func SucceedResult(msg string) Result

type Router

type Router struct {
	*gin.Engine
	C *controller.Controller
}

func (*Router) Authorize

func (r *Router) Authorize(ctx *gin.Context)

func (*Router) Challenge

func (r *Router) Challenge(ctx *gin.Context)

func (*Router) GetLogByDate

func (r *Router) GetLogByDate(ctx *gin.Context)

GET /logs/date

func (*Router) GetLogByUser

func (r *Router) GetLogByUser(ctx *gin.Context)

GET /logs/username

func (*Router) GetLogs

func (r *Router) GetLogs(ctx *gin.Context)

GET /logs

func (*Router) Login

func (r *Router) Login(ctx *gin.Context)

POST /login

func (*Router) Register

func (r *Router) Register(ctx *gin.Context)

func (*Router) UpdatePassword

func (r *Router) UpdatePassword(ctx *gin.Context)

func (*Router) UserByUsername

func (r *Router) UserByUsername(ctx *gin.Context)

func (*Router) UsernameByUUID

func (r *Router) UsernameByUUID(ctx *gin.Context)

type Token

type Token struct {
	JWT string `json:"jwt"`
}