biu

package module
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2026 License: LGPL-3.0 Imports: 25 Imported by: 0

README

BIU

a set of toolkits for go-restful.

GitHub release GoDoc Go Report Card Ask DeepWiki

Installation

go get -u github.com/tuotoo/biu

Examples

pkg-examples

Contributing

All our projects follow the GitFlow branching model, from development to release. If you are not familiar with it, there are several guides and tutorials to make you understand what it is about.

Thanks

kindly supperted by Jetbrains Open Source License

Documentation

Index

Constants

View Source 
const (
	// MIME_HTML_FORM is application/x-www-form-urlencoded header
	MIME_HTML_FORM = "application/x-www-form-urlencoded"
	// MIME_FILE_FORM is multipart/form-data
	MIME_FILE_FORM = "multipart/form-data"
)

Variables

View Source 
var AutoGenPathDoc = true
View Source 
var DefaultContainer = New(restful.DefaultContainer)

Functions

func AddServices 

func AddServices(prefix string, opts opt.ServicesFuncArr, wss ...NS)

AddServices adds services with namespace.

func AuthFilter 

func AuthFilter(code int, i *auth.Instance) restful.FilterFunction

AuthFilter checks if request contains JWT, and sets UserID in Attribute if exists,

func DefaultErrorTransformer added in v0.5.15 

func DefaultErrorTransformer(c *Container) func(ctx box.Ctx)

func DefaultResponseTransformer added in v0.5.15 

func DefaultResponseTransformer(ctx box.Ctx)

func Filter 

func Filter(f func(ctx box.Ctx)) restful.FilterFunction

Filter transform a biu handler to a restful.FilterFunction

func FilterWithLogger added in v0.5.0 

func FilterWithLogger(f func(ctx box.Ctx), logger *slog.Logger) restful.FilterFunction

func Handle 

func Handle(f func(ctx box.Ctx)) restful.RouteFunction

Handle transform a biu handler to a restful.RouteFunction.

func HandleWithLogger added in v0.5.0 

func HandleWithLogger(f func(ctx box.Ctx), logger *slog.Logger) restful.RouteFunction

func ListenAndServe added in v0.3.6 

func ListenAndServe(srv *http.Server, addrChan chan<- string) error

ListenAndServe listens on the TCP network address srv.Addr and then calls Serve to handle requests on incoming connections. Accepted connections are configured to enable TCP keep-alives. If srv.Addr is blank, ":http" is used. ListenAndServe always returns a non-nil error.

func ListenAndServeTLS added in v0.9.0 

func ListenAndServeTLS(srv *http.Server, addrChan chan<- string) error

ListenAndServeTLS listens on TCP and serves TLS with the server's TLSConfig.

func LogFilter 

func LogFilter(c ...*Container) restful.FilterFunction

LogFilter logs 

{
	remote_addr,
	method,
	uri,
	proto,
	status_code,
	content_length,
}

for each request

func NewSwaggerService 

func NewSwaggerService(info SwaggerInfo) *restful.WebService

NewSwaggerService creates a swagger webservice in /swagger

func Run 

func Run(addr string, opts ...opt.RunFunc)

Run starts up a web server with default container.

func WrapHandler 

func WrapHandler(f func(ctx box.Ctx)) http.HandlerFunc

WrapHandler wraps a biu handler to http.HandlerFunc

Types

type Container 

type Container struct {
	*restful.Container
	*http.Server
	// contains filtered or unexported fields
}

Container of restful

func New 

func New(container ...*restful.Container) *Container

New creates a new restful container with default response and error transformer.

func NewContainer added in v0.5.15 

func NewContainer(container ...*restful.Container) *Container

NewContainer creates a new restful container.

func (*Container) AddServices 

func (c *Container) AddServices(prefix string, opts opt.ServicesFuncArr, wss ...NS)

AddServices adds services with namespace for container.

func (*Container) DefaultErrorTransformer added in v0.6.5 

func (c *Container) DefaultErrorTransformer() *Container

DefaultErrorTransformer is a chainable api.

func (*Container) DefaultLogFilter added in v0.6.5 

func (c *Container) DefaultLogFilter() *Container

DefaultLogFilter is a chainable api.

func (*Container) DefaultResponseTransformer added in v0.6.5 

func (c *Container) DefaultResponseTransformer() *Container

DefaultResponseTransformer is a chainable api.

func (*Container) ErrorMap added in v0.5.15 

func (c *Container) ErrorMap() map[int]string

func (*Container) FilterFunc added in v0.5.0 

func (c *Container) FilterFunc(f func(ctx box.Ctx)) restful.FilterFunction

FilterFunc transform a biu handler to a restful.FilterFunction

func (*Container) Handle added in v0.5.0 

func (c *Container) Handle(f func(ctx box.Ctx)) restful.RouteFunction

func (*Container) NewSwaggerService 

func (c *Container) NewSwaggerService(info SwaggerInfo) *restful.WebService

NewSwaggerService creates a swagger webservice in /swagger

func (*Container) NewTestServer added in v0.2.0 

func (c *Container) NewTestServer() *TestServer

NewTestServer returns a Test Server.

func (*Container) NewWS added in v0.6.4 

func (c *Container) NewWS() WS

func (*Container) RouteAPI added in v0.6.6 

func (c *Container) RouteAPI(f any, opts ...opt.RouteAPIOpts) opt.RouteFunc

func (*Container) RouteIDMap added in v0.5.15 

func (c *Container) RouteIDMap() map[string]string

func (*Container) Run 

func (c *Container) Run(addr string, opts ...opt.RunFunc)

Run starts up a web server for container.

func (*Container) SetLogger added in v0.6.5 

func (c *Container) SetLogger(logger *slog.Logger) *Container

SetLogger sets the slog.Logger of the Container

type CtlInterface 

type CtlInterface interface {
	WebService(WS)
}

CtlInterface is the interface of controllers

type NS 

type NS struct {
	NameSpace    string       // url parent of controller
	Controller   CtlInterface // controller implement CtlInterface
	Desc         string       // description of controller of namespace
	ExternalDesc string       // external documentation of controller
	ExternalURL  string       // external url of ExternalDesc
}

NS contains configuration of a namespace

type SwaggerInfo 

type SwaggerInfo struct {
	Title          string
	Description    string
	TermsOfService string
	ContactName    string
	ContactURL     string
	ContactEmail   string
	LicenseName    string
	LicenseURL     string
	Version        string
	WebServicesURL string
	DisableCORS    bool
	// swagger service will be running under
	// http://<api>/<RoutePrefix>/<RouteSuffix>
	// by default the RouteSuffix is swagger
	RoutePrefix string
	RouteSuffix string
}

SwaggerInfo contains configuration of swagger documents.

type TestServer added in v0.2.0 

type TestServer struct {
	*httptest.Server
}

TestServer wraps a httptest.Server

func NewTestServer added in v0.2.0 

func NewTestServer() *TestServer

NewTestServer returns a Test Server.

type WS 

type WS struct {
	*restful.WebService
	*Container
	// contains filtered or unexported fields
}

WS extends *restful.WebService

func (WS) Route 

func (ws WS) Route(builder *restful.RouteBuilder, opts ...opt.RouteFunc)

Route creates a new Route using the RouteBuilder and add to the ordered list of Routes.

Source Files

View all Source files

Directories

Path Synopsis
cert
Package cert provides automatic TLS certificate management via ACME (Let's Encrypt / ZeroSSL).
 Package cert provides automatic TLS certificate management via ACME (Let's Encrypt / ZeroSSL).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
⌂ 换网址