csweb

package module

v0.0.3 Latest Latest Go to latest Published: Jul 5, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stonejianbu/csweb

Links

Open Source Insights

README ¶

csweb

Being the cornerstone framework of the web for golang

Characteristic

provides HTTP and GRPC serve
validator
metrics (prometheus)
tracer (zipkin)
log with traceID
tools library (gorm/jwt/seata...)
jwt Auth
recovery
ratelimit
error handle

TODO List

Docker/Makefile
service discovery
goroutine pool
auto generate infrastructure code
cache (redis)
pub/sub
cron
config center (apollo)
project template

Documentation ¶

Index ¶

func Cors(handler http.Handler) http.Handler
type App
- func NewApp(name string, options ...ServeOptions) *App
- func (that *App) InitServe(s ServeInterface)
- func (that *App) Run(addr string) error
type Options
type ServeInterface
type ServeOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Cors ¶ added in v0.0.3

func Cors(handler http.Handler) http.Handler

Types ¶

type App ¶

type App struct {
	Name string
	Addr string

	Serve ServeInterface
	// contains filtered or unexported fields
}

func NewApp ¶

func NewApp(name string, options ...ServeOptions) *App

NewApp new an app with name

func (*App) InitServe ¶

func (that *App) InitServe(s ServeInterface)

InitServe init the http serve and grpc serve

func (*App) Run ¶

func (that *App) Run(addr string) error

type Options ¶

type Options struct {
	Gateway       string
	TraceAddr     string
	EnableMetrics bool
	MetricsAddr   string
	JwtSignKey    string

	RateLimit int
	// contains filtered or unexported fields
}

type ServeInterface ¶

type ServeInterface interface {
	GRPCServe(s *grpc.Server) error
	HTTPServe(mux *runtime.ServeMux, opts []grpc.DialOption) error
}

type ServeOptions ¶

type ServeOptions func(opts *Options)

func WithGateway ¶

func WithGateway(addr string) ServeOptions

WithGateway enable the gateway and specify the address

func WithJwtAuth ¶

func WithJwtAuth(signKey string, authFilterMethods ...string) ServeOptions

func WithMetrics ¶

func WithMetrics(addr string) ServeOptions

func WithRateLimit ¶

func WithRateLimit(num int) ServeOptions

func WithTracer ¶

func WithTracer(addr string) ServeOptions

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
pkg
csweb-utils
protos
common

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