connect

README

Connect Middleware for echo

Installation

To install the package, run:

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

Getting Started

package main

import (
	"github.com/go-zoox/connect-middleware-for-echo"
	"github.com/labstack/echo/v4"
)

func main() {
	r := echo.New()

	r.Use(connect.Create("YOUR_SECRET_KEY"))

	r.GET("/user", func(c echo.Context) error {
		user, err := connect.GetUser(c)
		if err != nil {
			return c.JSON(401, map[string]any{
				"message": "unauthorized",
			})
		}

		return c.JSON(200, map[string]any{
			"user": user,
		})
	})

	r.GET("/", func(c echo.Context) error {
		return c.JSON(200, map[string]any{
			"message": "helloworld",
		})
	})

	r.Logger.Fatal(r.Start(":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) echo.MiddlewareFunc
• func GetToken(ctx echo.Context) (token string, err error)
• func GetUser(ctx echo.Context) (u *user.User, err error)
• func MustGetToken(ctx echo.Context) (token string)
• func MustGetUser(ctx echo.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) echo.MiddlewareFunc

Create creates a connect middleware for gin.

func GetToken

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

GetToken get user from context.

func GetUser

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

GetUser gets the user from the context.

func MustGetToken

func MustGetToken(ctx echo.Context) (token string)

MustGetToken get user from context.

func MustGetUser

func MustGetUser(ctx echo.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.