restserver

package

v1.0.0 Latest Latest Go to latest Published: May 30, 2023 License: Apache-2.0 Imports: 20 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/coderi421/gframework

Documentation ¶

Index ¶

type JwtInfo
type Server
- func NewServer(opts ...ServerOption) *Server
- func (s *Server) Start(ctx context.Context) error
- func (s *Server) Stop(ctx context.Context) error
type ServerOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type JwtInfo ¶

type JwtInfo struct {
	//defaults to "JWT"
	Realm string
	//defaults to empty
	Key string
	//defaults to 7 days
	Timeout time.Duration
	//defaults to 7 days 刷新时长
	MaxRefresh time.Duration
}

type Server ¶

type Server struct {
	*gin.Engine
	// contains filtered or unexported fields
}

wrapper for gin.Engine

func NewServer ¶

func NewServer(opts ...ServerOption) *Server

func (*Server) Start ¶

func (s *Server) Start(ctx context.Context) error

start rest server

func (*Server) Stop ¶

func (s *Server) Stop(ctx context.Context) error

type ServerOption ¶

type ServerOption func(*Server)

func WithCustomMiddlewares ¶

func WithCustomMiddlewares(middlewares []gin.HandlerFunc) ServerOption

func WithEnableProfiling ¶

func WithEnableProfiling(profiling bool) ServerOption

func WithHealthz ¶

func WithHealthz(healthz bool) ServerOption

func WithJwt ¶

func WithJwt(jwt *JwtInfo) ServerOption

func WithMetrics ¶

func WithMetrics(metrics bool) ServerOption

func WithMiddlewares ¶

func WithMiddlewares(middlewares []string) ServerOption

func WithMode ¶

func WithMode(mode string) ServerOption

func WithPort ¶

func WithPort(port int) ServerOption

func WithServiceName ¶

func WithServiceName(srvName string) ServerOption

func WithTransName ¶

func WithTransName(transName string) ServerOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
middlewares
auth Package auth defines authentication strategy like Basic, Bearer.	Package auth defines authentication strategy like Basic, Bearer.
pprof
validation

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL