web

package

v1.1.0 Latest Latest Go to latest Published: Apr 19, 2025 License: MIT Imports: 8 Imported by: 0

Details

Package web provides the web server setup and HTTP utilities.

Package web provides web server setup and HTTP utilities.

This section is empty.

This section is empty.

func NewClient(p ClientParams) *client.Client

NewClient creates a new API client

func NewMux(UIHandler http.Handler, APIHandlers http.Handler) *http.ServeMux

NewMux creates the main HTTP ServeMux.

func NewServer(mux *http.ServeMux) *http.Server

NewServer creates the main HTTP server instance.

func RegisterWebServerHooks(lifecycle fx.Lifecycle, httpServer *http.Server, logger log.Logger)

RegisterWebServerHooks registers the OnStart and OnStop hooks for the HTTP server.

type ClientParams struct {
	fx.In

	Config config.ClientConfig
	Logger log.Logger
}

ClientParams contains the parameters needed for client creation

type RouteParams = server.RouteParams

RouteParams aliases server.RouteParams for backward compatibility

Path	Synopsis
client Package client provides HTTP client functionality for API interactions.	Package client provides HTTP client functionality for API interactions.
config Package config provides configuration structures for the web server.	Package config provides configuration structures for the web server.
handlers Package handlers provides API endpoints and HTTP request handlers.	Package handlers provides API endpoints and HTTP request handlers.
middleware Package middleware provides HTTP middleware components for the web server.	Package middleware provides HTTP middleware components for the web server.
server Package server provides HTTP server setup and lifecycle management.	Package server provides HTTP server setup and lifecycle management.
templates