core

Documentation

Index

• Constants
• Variables
• func CreateValidator()
• func GetAssetDir() string
• func GetConfigFile() string
• func GetProjectFilePath(projectID int64) string
• func GetProjectPath(projectID int64) string
• func GetRepositoryPath() string
• func Log(lv LogLevel, content string)
• type Goploy
• type LogLevel
• type Response
• type Route
  • func NewRoute(pattern, method string, callback func(gp *Goploy) Response) Route
  • func (r Route) Middleware(middleware func(gp *Goploy) error) Route
  • func (r Route) Roles(roles ...string) Route
  • func (r Route) White() Route
• type RouteApi
• type Router
  • func NewRouter() Router
  • func (rt Router) Add(ra RouteApi) Router
  • func (rt Router) Middleware(middleware func(gp *Goploy) error)
  • func (rt Router) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (rt Router) Start()

Constants

const (
	RoleAdmin        = "admin"
	RoleManager      = "manager"
	RoleGroupManager = "group-manager"
	RoleMember       = "member"
)

role

const NamespaceHeaderName = "G-N-ID"

NamespaceHeaderName namespace cookie name

Variables

var (
	AssetDir string
	Gwg      sync.WaitGroup
)

var Roles = [...]string{RoleAdmin, RoleManager, RoleGroupManager, RoleMember}

Roles all role

var Trans ut.Translator

Trans Translator

var Validate *validator.Validate

Validate use a single instance of Validate, it caches struct info

Functions

func CreateValidator

func CreateValidator()

CreateValidator create a single Validator

func GetAssetDir

func GetAssetDir() string

GetAssetDir if env = 'production' return absolute else return relative

func GetConfigFile

func GetConfigFile() string

func GetProjectFilePath

func GetProjectFilePath(projectID int64) string

func GetProjectPath

func GetProjectPath(projectID int64) string

func GetRepositoryPath

func GetRepositoryPath() string

func Log

func Log(lv LogLevel, content string)

Log information to file with logged day

Types

type Goploy

type Goploy struct {
	UserInfo       model.User
	Namespace      model.Namespace
	Request        *http.Request
	ResponseWriter http.ResponseWriter
	URLQuery       url.Values
	Body           []byte
}

Goploy callback param

type LogLevel

type LogLevel string

LogLevel is log level

const (
	TRACE   LogLevel = "TRACE: "
	WARNING LogLevel = "WARNING: "
	INFO    LogLevel = "INFO: "
	ERROR   LogLevel = "ERROR: "
)

log level

type Response

type Response interface {
	Write(http.ResponseWriter) error
}

type Route

type Route struct {
	// contains filtered or unexported fields
}

func NewRoute

func NewRoute(pattern, method string, callback func(gp *Goploy) Response) Route

func (Route) Middleware

func (r Route) Middleware(middleware func(gp *Goploy) error) Route

Middleware global Middleware handle function

func (Route) Roles

func (r Route) Roles(roles ...string) Route

Roles Add much permission to the Route

func (Route) White

func (r Route) White() Route

White no need to check login

type RouteApi

type RouteApi interface {
	Routes() []Route
}

type Router

type Router struct {
	// contains filtered or unexported fields
}

Router is Route slice and global middlewares

func NewRouter

func NewRouter() Router

func (Router) Add

func (rt Router) Add(ra RouteApi) Router

Add pattern path callback where path should be handled

func (Router) Middleware

func (rt Router) Middleware(middleware func(gp *Goploy) error)

Middleware global Middleware handle function

func (Router) ServeHTTP

func (rt Router) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (Router) Start

func (rt Router) Start()

Start a router