restserver

package

v0.0.0-...-a23f37e Latest Latest Go to latest Published: Apr 28, 2024 License: MIT Imports: 24 Imported by: 0

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

gitee.com/tylf2018/go-micro-framework

Links

Open Source Insights

Documentation ¶

Index ¶

type Server
- func NewServer(opts ...ServerOption) *Server
type ServerOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Server ¶

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

Server wrapper for gin.Engine

func NewServer ¶

func NewServer(opts ...ServerOption) *Server

func (*Server) Endpoint ¶

func (s *Server) Endpoint() (*url.URL, error)

func (*Server) RegistryWebsocket ¶

func (s *Server) RegistryWebsocket(relativePath string)

func (*Server) SocketIoServer ¶

func (s *Server) SocketIoServer() *socketio.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

func (*Server) Translator ¶

func (s *Server) Translator() ut.Translator

type ServerOption ¶

type ServerOption func(*Server)

func WithAddress ¶

func WithAddress(addr string) ServerOption

func WithClientEnableTracing ¶

func WithClientEnableTracing(enableTracing bool) ServerOption

WithClientEnableTracing 设置是否开启链路追踪

func WithDebugMode ¶

func WithDebugMode() ServerOption

func WithEnTransNames ¶

func WithEnTransNames() ServerOption

func WithEnableMetrics ¶

func WithEnableMetrics(enable bool) ServerOption

func WithEnableProfiling ¶

func WithEnableProfiling(enable bool) ServerOption

func WithEnableSocketIoServer ¶

func WithEnableSocketIoServer(enableSocketIoServer bool) ServerOption

func WithMiddlewares ¶

func WithMiddlewares(middlewares ...gin.HandlerFunc) ServerOption

func WithReleaseMode ¶

func WithReleaseMode() ServerOption

func WithSocketIoServer ¶

func WithSocketIoServer(socketIoServer *socketio.Server) ServerOption

func WithTLSConfig ¶

func WithTLSConfig(certFile, keyFile string) ServerOption

WithTLSConfig with TLS config.

func WithTestMode ¶

func WithTestMode() ServerOption

func WithTransName ¶

func WithTransName(transName string) ServerOption

func WithZhTransNames ¶

func WithZhTransNames() ServerOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
middlewares
auth
auth/strategy
pprof
validation

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