connect

README

Connect Middleware for Gin

Installation

To install the package, run:

go get github.com/go-zoox/connect-middleware-for-gin

Getting Started

package main

import (
	"github.com/gin-gonic/gin"
	"github.com/go-zoox/connect-middleware-for-gin"
)

func main() {
	r := gin.Default()
	
	r.Use(connect.Create("YOUR_SECRET_KEY"))

	r.GET("/user", func(c *gin.Context) {
		user, err := connect.GetUser(c)
		if err != nil {
			c.JSON(401, gin.H{
				"message": "unauthorized",
			})
			return
		}

		c.JSON(200, gin.H{
			"user": user,
		})
	})

	r.GET("/", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "helloworld",
		})
	})

	r.Run() // 监听并在 0.0.0.0:8080 上启动服务
}

Related Projects

• go-zoox/connect - The Auth Connect.
• go-zoox/connect-middleware-for-zoox - The Auth Connect Middleware for Zoox.

License

GoZoox is released under the MIT License.

Documentation

Index

• Constants
• Variables
• func Create(secretKey string, opts ...*CreateOptions) gin.HandlerFunc
• func GetToken(ctx *gin.Context) (token string, err error)
• func GetUser(ctx *gin.Context) (u *user.User, err error)
• func MustGetToken(ctx *gin.Context) (token string)
• func MustGetUser(ctx *gin.Context) (u *user.User)
• type CreateOptions

Constants

const ContextUserKey = "zoox.connect::user"

ContextUserKey is the key for the user in the context.

Variables

var Version = "1.2.0"

Version is the current version of the package.

Functions

func Create

func Create(secretKey string, opts ...*CreateOptions) gin.HandlerFunc

Create creates a connect middleware for gin.

func GetToken

func GetToken(ctx *gin.Context) (token string, err error)

GetToken get user from context.

func GetUser

func GetUser(ctx *gin.Context) (u *user.User, err error)

GetUser gets the user from the context.

func MustGetToken

func MustGetToken(ctx *gin.Context) (token string)

MustGetToken get user from context.

func MustGetUser

func MustGetUser(ctx *gin.Context) (u *user.User)

MustGetUser get user from context.

Types

type CreateOptions

type CreateOptions struct {
	RequireAuth bool
}

CreateOptions is the options for the Create middleware.