service

Documentation

Index

• Constants
• Variables
• func GetUser(c *gin.Context) (*user.User, error)
• func GetUserIP(c *gin.Context) (string, error)
• func IsLogin(c *gin.Context) bool
• type Service
  • func New(serviceName string, serviceID uint) *Service
  • func (s *Service) Route() *gin.Engine
  • func (s *Service) Run(addr ...string)

Constants

const (
	ENV = "APICON_SERVICE"

	ApiconAuthHeader         = "X-Apicon-Auth"
	ApiconUserIDHeader       = "X-Apicon-User-ID"
	ApiconUserNameHeader     = "X-Apicon-User-Name"
	ApiconUserEmailHeader    = "X-Apicon-User-Email"
	ApiconUserNicknameHeader = "X-Apicon-User-Nickname"
	ApiconUserKeyHeader      = "X-Apicon-Key"
	UserIPHeader             = "X-Real-Ip"
)

Variables

var (
	ErrNilGinContext = errors.New("gin context is nil")
	ErrUserNotLogin  = errors.New("user not login")
)

Functions

func GetUser

func GetUser(c *gin.Context) (*user.User, error)

GetUser returns user information from the Gin request context.

func GetUserIP

func GetUserIP(c *gin.Context) (string, error)

GetUserIP returns user IP address from the Gin request context.

func IsLogin

func IsLogin(c *gin.Context) bool

IsLogin returns user login status by checking the Gin request context.

Types

type Service

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

func New

func New(serviceName string, serviceID uint) *Service

New returns a new service instance.

func (*Service) Route

func (s *Service) Route() *gin.Engine

Route returns the Gin engine.

func (*Service) Run

func (s *Service) Run(addr ...string)