ginp

package module

v0.0.0-...-1b2714a Latest Latest Go to latest Published: Dec 26, 2019 License: MIT Imports: 7 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/youlu-cn/ginp

Links

Open Source Insights

README ¶

ginp

Documentation ¶

Index ¶

Constants
Variables
func AddController(ctl Controller) error
func Auth(obj Controller) gin.HandlerFunc
func DisableToken()
func Mode() string
func SetEngine(engine *gin.Engine)
func SetMode(mode string)
func SetTokenSignKey(signKey string)
type Claims
type Controller
type H
type JWT
- func NewJWT(key string) *JWT
- func (j *JWT) Create(user *UserInfo) (string, error)
- func (j *JWT) GetKey(token *jwt.Token) (interface{}, error)
- func (j *JWT) Parse(val string) (*Claims, error)
- func (j *JWT) Refresh(val string) (string, error)
type Model
type Request
- func (req *Request) Bind(obj interface{}) error
- func (req *Request) BindJSON(obj interface{}) error
- func (req *Request) Context() *gin.Context
- func (req *Request) GetUserInfo() *UserInfo
type Response
- func DataResponse(data interface{}) *Response
- func ErrorResponse(code int, err error) *Response
- func TokenResponse(user *UserInfo, signKey string) *Response
type UserInfo

Constants ¶

View Source

const (
	DebugMode   = "debug"
	ReleaseMode = "release"
	TestMode    = "test"
)

View Source

const (
	TokenExpire = 7 * 24 * time.Hour
)

Variables ¶

View Source

var (
	TokenExpired = errors.New("token expired")
	TokenInvalid = errors.New("invalid token")
)

View Source

var (
	Engine = gin.Default()
)

Functions ¶

func AddController ¶

func AddController(ctl Controller) error

func Auth ¶

func Auth(obj Controller) gin.HandlerFunc

func DisableToken ¶

func DisableToken()

func Mode ¶

func Mode() string

func SetEngine ¶

func SetEngine(engine *gin.Engine)

func SetMode ¶

func SetMode(mode string)

func SetTokenSignKey ¶

func SetTokenSignKey(signKey string)

Types ¶

type Claims ¶

type Claims struct {
	*jwt.StandardClaims
	*UserInfo
}

type Controller ¶

type Controller interface {
	Group() string
	TokenRequired(string) bool
}

type H ¶

type H gin.H

type JWT ¶

type JWT struct {
	SignKey []byte
}

func NewJWT ¶

func NewJWT(key string) *JWT

func (*JWT) Create ¶

func (j *JWT) Create(user *UserInfo) (string, error)

func (*JWT) GetKey ¶

func (j *JWT) GetKey(token *jwt.Token) (interface{}, error)

func (*JWT) Parse ¶

func (j *JWT) Parse(val string) (*Claims, error)

func (*JWT) Refresh ¶

func (j *JWT) Refresh(val string) (string, error)

type Model ¶

type Model struct {
	ID        uint64    `json:"id" gorm:"primary_key"`
	CreatedAt time.Time `json:"create_at" gorm:"index;not null;default:CURRENT_TIMESTAMP"`
	UpdatedAt time.Time `json:"update_at" gorm:"not null;default:CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP"`
}

type Request ¶

type Request struct {
	*http.Request
	// contains filtered or unexported fields
}

func (*Request) Bind ¶

func (req *Request) Bind(obj interface{}) error

func (*Request) BindJSON ¶

func (req *Request) BindJSON(obj interface{}) error

func (*Request) Context ¶

func (req *Request) Context() *gin.Context

func (*Request) GetUserInfo ¶

func (req *Request) GetUserInfo() *UserInfo

type Response ¶

type Response struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}

func DataResponse ¶

func DataResponse(data interface{}) *Response

func ErrorResponse ¶

func ErrorResponse(code int, err error) *Response

func TokenResponse ¶

func TokenResponse(user *UserInfo, signKey string) *Response

type UserInfo ¶

type UserInfo struct {
	Name   string   `json:"name"`
	Email  string   `json:"email"`
	Avatar string   `json:"avatar"`
	Roles  []string `json:"roles"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL