echosession

README

Session middleware for Echo

Quick Start

Download and install

$ go get -u -v github.com/go-session/echo-session

Create file server.go

package main

import (
	"fmt"
	"net/http"

	"github.com/go-session/echo-session"
	"github.com/labstack/echo"
	"github.com/go-session/session"
)

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

	e.Use(echosession.New())

	e.GET("/", func(ctx echo.Context) error {
		store := echosession.FromContext(ctx)
		store.Set("foo", "bar")
		err := store.Save()
		if err != nil {
			return err
		}
		return ctx.Redirect(302, "/foo")
	})

	e.GET("/foo", func(ctx echo.Context) error {
		store := echosession.FromContext(ctx)
		foo, ok := store.Get("foo")
		if !ok {
			return ctx.String(http.StatusNotFound, "not found")
		}
		return ctx.String(http.StatusOK, fmt.Sprintf("foo:%s", foo))
	})

	e.Logger.Fatal(e.Start(":8080"))
}

Build and run

$ go build server.go
$ ./server

Open in your web browser

http://localhost:8080

foo:bar

MIT License

Copyright (c) 2018 Lyric

Documentation

Index

• Variables
• func Destroy(ctx echo.Context) error
• func FromContext(ctx echo.Context) session.Store
• func New(opt ...session.Option) echo.MiddlewareFunc
• func NewWithConfig(config Config, opt ...session.Option) echo.MiddlewareFunc
• func Refresh(ctx echo.Context) (session.Store, error)
• type Config
• type Skipper

Variables

var (
	// DefaultConfig is the default Recover middleware config.
	DefaultConfig = Config{
		Skipper:  func(_ echo.Context) bool { return false },
		StoreKey: "github.com/go-session/echo-session",
	}
)

Functions

func Destroy

func Destroy(ctx echo.Context) error

Destroy a session

func FromContext

func FromContext(ctx echo.Context) session.Store

FromContext get session storage from context

func New

func New(opt ...session.Option) echo.MiddlewareFunc

New create a session middleware

func NewWithConfig

func NewWithConfig(config Config, opt ...session.Option) echo.MiddlewareFunc

NewWithConfig create a session middleware

func Refresh

func Refresh(ctx echo.Context) (session.Store, error)

Refresh a session and return to session storage

Types

type Config

type Config struct {
	// Skipper defines a function to skip middleware.
	Skipper Skipper
	// StoreKey keys stored in the context
	StoreKey string
}

Config defines the config for Session middleware.

type Skipper

type Skipper func(c echo.Context) bool

Skipper defines a function to skip middleware. Returning true skips processing the middleware.