web

Documentation

Index

• func RegisterRoutes() *gin.Engine
• type ArticleHandler
  • func NewArticleHandler(svc service.ArticleService, l logger.LoggerV1) *ArticleHandler
  • func (h *ArticleHandler) Edit(ctx *gin.Context)
  • func (h *ArticleHandler) Publish(ctx *gin.Context)
  • func (h *ArticleHandler) RegisterRoutes(server *gin.Engine)
• type ArticleReq
• type OAuth2WechatHandler
  • func NewOAuth2WechatHandler(svc wechat.Service, userSvc service.UserService, jwtHdl ijwt.Handler, ...) *OAuth2WechatHandler
  • func (h *OAuth2WechatHandler) AuthURL(ctx *gin.Context)
  • func (h *OAuth2WechatHandler) Callback(ctx *gin.Context)
  • func (h *OAuth2WechatHandler) RegisterRoutes(server *gin.Engine)
• type Result
• type StateClaims
• type UserHandler
  • func NewUserHandler(svc service.UserService, codeSvc service.CodeService, jwtHdl ijwt.Handler) *UserHandler
  • func (u *UserHandler) Edit(ctx *gin.Context)
  • func (u *UserHandler) EditV1() gin.HandlerFunc
  • func (u *UserHandler) Login(ctx *gin.Context)
  • func (u *UserHandler) LoginJWT(ctx *gin.Context)
  • func (u *UserHandler) LoginSMS(ctx *gin.Context)
  • func (u *UserHandler) Logout(ctx *gin.Context)
  • func (u *UserHandler) LogoutJWT(ctx *gin.Context)
  • func (u *UserHandler) Profile(ctx *gin.Context)
  • func (u *UserHandler) ProfileJWT(ctx *gin.Context)
  • func (u *UserHandler) RefreshToken(ctx *gin.Context)
  • func (u *UserHandler) RegisterRoutes(server *gin.Engine)
  • func (u *UserHandler) RegisterRoutesV1(ug *gin.RouterGroup)
  • func (u *UserHandler) SendLoginSMSCode(ctx *gin.Context)
  • func (u *UserHandler) SignUp(ctx *gin.Context)
• type WechatHandlerConfig

Functions

func RegisterRoutes

func RegisterRoutes() *gin.Engine

Types

type ArticleHandler

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

func NewArticleHandler

func NewArticleHandler(svc service.ArticleService, l logger.LoggerV1) *ArticleHandler

func (*ArticleHandler) Edit

func (h *ArticleHandler) Edit(ctx *gin.Context)

func (*ArticleHandler) Publish

func (h *ArticleHandler) Publish(ctx *gin.Context)

func (*ArticleHandler) RegisterRoutes

func (h *ArticleHandler) RegisterRoutes(server *gin.Engine)

type ArticleReq

type ArticleReq struct {
	Id      int64  `json:"id"`
	Title   string `json:"title"`
	Content string `json:"content"`
}

type OAuth2WechatHandler

type OAuth2WechatHandler struct {
	ijwt.Handler
	// contains filtered or unexported fields
}

func NewOAuth2WechatHandler

func NewOAuth2WechatHandler(svc wechat.Service,
	userSvc service.UserService,
	jwtHdl ijwt.Handler,
	cfg WechatHandlerConfig) *OAuth2WechatHandler

func (*OAuth2WechatHandler) AuthURL

func (h *OAuth2WechatHandler) AuthURL(ctx *gin.Context)

func (*OAuth2WechatHandler) Callback

func (h *OAuth2WechatHandler) Callback(ctx *gin.Context)

func (*OAuth2WechatHandler) RegisterRoutes

func (h *OAuth2WechatHandler) RegisterRoutes(server *gin.Engine)

type Result

type Result struct {
	// 这个叫做业务错误码
	Code int    `json:"code"`
	Msg  string `json:"msg"`
	Data any    `json:"data"`
}

type StateClaims

type StateClaims struct {
	State string
	jwt.RegisteredClaims
}

type UserHandler

type UserHandler struct {
	ijwt.Handler
	// contains filtered or unexported fields
}

UserHandler 我准备在它上面定义跟用户有关的路由

func NewUserHandler

func NewUserHandler(svc service.UserService,
	codeSvc service.CodeService, jwtHdl ijwt.Handler) *UserHandler

func (*UserHandler) Edit

func (u *UserHandler) Edit(ctx *gin.Context)

func (*UserHandler) EditV1

func (u *UserHandler) EditV1() gin.HandlerFunc

func (*UserHandler) Login

func (u *UserHandler) Login(ctx *gin.Context)

func (*UserHandler) LoginJWT

func (u *UserHandler) LoginJWT(ctx *gin.Context)

func (*UserHandler) LoginSMS

func (u *UserHandler) LoginSMS(ctx *gin.Context)

func (*UserHandler) Logout

func (u *UserHandler) Logout(ctx *gin.Context)

func (*UserHandler) LogoutJWT

func (u *UserHandler) LogoutJWT(ctx *gin.Context)

func (*UserHandler) Profile

func (u *UserHandler) Profile(ctx *gin.Context)

func (*UserHandler) ProfileJWT

func (u *UserHandler) ProfileJWT(ctx *gin.Context)

func (*UserHandler) RefreshToken

func (u *UserHandler) RefreshToken(ctx *gin.Context)

RefreshToken 可以同时刷新长短 token，用 redis 来记录是否有效，即 refresh_token 是一次性的 参考登录校验部分，比较 User-Agent 来增强安全性

func (*UserHandler) RegisterRoutes

func (u *UserHandler) RegisterRoutes(server *gin.Engine)

func (*UserHandler) RegisterRoutesV1

func (u *UserHandler) RegisterRoutesV1(ug *gin.RouterGroup)

func (*UserHandler) SendLoginSMSCode

func (u *UserHandler) SendLoginSMSCode(ctx *gin.Context)

func (*UserHandler) SignUp

func (u *UserHandler) SignUp(ctx *gin.Context)

type WechatHandlerConfig

type WechatHandlerConfig struct {
	Secure bool
}