https://github.com/utahta/echo-sessions

Sessions middleware for Echo
https://github.com/utahta/echo-sessions

echo go golang middleware session

Last synced: 3 days ago
JSON representation

Sessions middleware for Echo

• Host: GitHub
• URL: https://github.com/utahta/echo-sessions
• Owner: utahta
• License: mit
• Created: 2017-01-29T16:59:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-10-30T15:23:23.000Z (about 7 years ago)
• Last Synced: 2024-11-14T23:11:38.840Z (2 months ago)
• Topics: echo, go, golang, middleware, session
• Language: Go
• Homepage:
• Size: 10.7 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sessions middleware for Echo

[![GitHub release](https://img.shields.io/github/release/utahta/echo-sessions.svg)](https://github.com/utahta/echo-sessions/releases) 

[![Build Status](https://travis-ci.org/utahta/echo-sessions.svg?branch=master)](https://travis-ci.org/utahta/echo-sessions)

This is a package of sessions middleware for Echo.  

A thin [gorilla/sessions](https://github.com/gorilla/sessions) wrapper.

## Install

```

$ go get -u github.com/utahta/echo-sessions

```

## Middleware usage

```go

import (

    "github.com/boj/redistore"

    "github.com/utahta/echo-sessions"

    "github.com/labstack/echo"

)

store, _ := redistore.NewRediStore(10, "tcp", ":6379", "", []byte("secret-key"))

e := echo.New()

e.Use(sessions.Sessions("SESSID", store))

```

## Helpers usage

```go

import "github.com/utahta/echo-sessions"

func example(c echo.Context) {

    sessions.Set(c, "key", "value")

    

    dst := sessions.GetRaw(c, "key")

    

    var dst string

    ok, err := sessions.Get(c, "key", &dst)

    

    var dst string

    ok := sessions.MustGet(c, "key", &dst)

    

    sessions.Delete(c, "key")

    

    ok := sessions.Exists(c, "key")

    

    sessions.Clear(c)

    

    sessions.Flashes(c vars...)

    

    sessions.AddFlash(c, value, vars...)

    

    err := sessions.Save(c)

}

```

## Learn more

### Get the session handler

```go

s := sessions.MustStart()

```

### Set key and value

```go

s.Set("key", "value")

```

### Get value by key

```go

var v string

ok, err := s.Get("key", &v)

```

or

```go

var v string

ok := s.MustGet("key", &v)

```

### Get raw value by key

```go

v := s.GetRaw("key") // returns (interface{})

```

### Check key exists

```go

if !s.Exists("key") {

    s.Set("key", "new value")

}

```

or

```go

var v string

if ok, err := s.Get("example1", &v); !ok && err == nil {

    s.Set("example1", "new value")

}

if ok := s.MustGet("example2", &v); !ok {

    s.Set("example2", "new value")

}

```

### Delete key

```go

s.Delete("key")

```

### Save this session

```go

err := s.Save()

```

## Contributing

1. Fork it ( https://github.com/utahta/echo-sessions/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request