admin

README

Staffio client for gin

Example

package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
	staffiogin "github.com/liut/staffio/client/gin"
)

func main() {

	router := gin.Default()
	loginPath := "/auth/login"
	staffiogin.SetLoginPath(loginPath)
	staffiogin.SetAdminPath("/admin")

	router.GET(loginPath, staffiogin.LoginHandler)
	router.GET("/auth/callback", staffiogin.AuthCodeCallback("admin"))

	adminGroup := router.Group("/admin", staffiogin.AuthMiddleware(true)) // auto redirect
	adminGroup.GET("/", handlerAdminWelcome)
	...

	apiGroup := router.Group("/api", AuthMiddleware(false)) // don't redirect
	apiGroup.GET("/me", staffiogin.HandlerShowMe)
	...

}

func handlerAdminWelcome(c *gin.Context) {
	user, _ := staffiogin.UserWithContext(c)
	...
}

Documentation

Index

• Constants
• Variables
• func AuthCodeCallback(roleName ...string) gin.HandlerFunc
• func AuthMiddleware(redirect bool) gin.HandlerFunc
• func HandlerShowMe(c *gin.Context)
• type User
  • func UserFromContext(c *gin.Context) (user *User, ok bool)

Constants

const (
	KeyOper = "oper"
)

Variables

var (
	LoginHandler = gin.WrapF(staffio.LoginHandler)
	SetLoginPath = staffio.SetLoginPath
	SetAdminPath = staffio.SetAdminPath
)

Functions

func AuthCodeCallback

func AuthCodeCallback(roleName ...string) gin.HandlerFunc

AuthCodeCallback Handler for Check auth with role[s] when auth-code callback

func AuthMiddleware

func AuthMiddleware(redirect bool) gin.HandlerFunc

func HandlerShowMe

func HandlerShowMe(c *gin.Context)

Types

type User

type User = staffio.User

func UserFromContext

func UserFromContext(c *gin.Context) (user *User, ok bool)