http

package
v0.0.7 Latest Latest
Warning

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

 Go to latest Published: Jun 28, 2026 License: MIT Imports: 42 Imported by: 0

Documentation

Index

Constants

View Source 
const SupportPackageIsVersion3 = true

SupportPackageIsVersion3 These constants should not be referenced from any other code.

Variables

This section is empty.

Functions

func BodyContentType 

func BodyContentType(v any) string

BodyContentType returns the content type carried by v or a binary default.

func BuildPath 

func BuildPath(pathTemplate string, msg any, opts ...BuildPathOption) string

BuildPath builds an HTTP request path from a path template and request message.

func CodecForRequest 

func CodecForRequest(r *http.Request, name string) (encoding.Codec, bool)

CodecForRequest get encoding.Codec via http.Request

func CodecForResponse 

func CodecForResponse(r *http.Response) encoding.Codec

CodecForResponse get encoding.Codec via http.Response

func DefaultErrorDecoder 

func DefaultErrorDecoder(_ context.Context, res *http.Response) error

DefaultErrorDecoder is an HTTP error decoder.

func DefaultErrorEncoder 

func DefaultErrorEncoder(w http.ResponseWriter, r *http.Request, err error)

DefaultErrorEncoder encodes the error to the HTTP response.

func DefaultRequestDecoder 

func DefaultRequestDecoder(r *http.Request, v any) error

DefaultRequestDecoder decodes the request body to object.

func DefaultRequestEncoder 

func DefaultRequestEncoder(_ context.Context, contentType string, in any) ([]byte, error)

DefaultRequestEncoder is an HTTP request encoder.

func DefaultRequestQuery 

func DefaultRequestQuery(r *http.Request, v any) error

DefaultRequestQuery decodes the request vars to object.

func DefaultRequestVars 

func DefaultRequestVars(r *http.Request, v any) error

DefaultRequestVars decodes the request vars to object.

func DefaultResponseDecoder 

func DefaultResponseDecoder(_ context.Context, res *http.Response, v any) error

DefaultResponseDecoder is an HTTP response decoder.

func DefaultResponseEncoder 

func DefaultResponseEncoder(w http.ResponseWriter, r *http.Request, v any) error

DefaultResponseEncoder encodes the object to the HTTP response.

func RequestFromServerContext 

func RequestFromServerContext(ctx context.Context) (*http.Request, bool)

RequestFromServerContext returns request from context.

func ResponseWriterFromServerContext 

func ResponseWriterFromServerContext(ctx context.Context) (http.ResponseWriter, bool)

ResponseWriterFromServerContext returns the http.ResponseWriter from context if available. This function provides backward compatibility and safe access to the ResponseWriter. Returns nil if the transport doesn't implement ResponseTransporter.

func SetCookie 

func SetCookie(ctx context.Context, cookie *http.Cookie)

SetCookie adds a Set-Cookie header to the provided ResponseWriter's headers. The provided cookie must have a valid Name. Invalid cookies may be silently dropped.

func SetOperation 

func SetOperation(ctx context.Context, op string)

SetOperation sets the transport operation.

Types

type AcceptCallOption 

type AcceptCallOption struct {
	EmptyCallOption
	ContentType string
}

AcceptCallOption sets the accepted response content type.

type BuildPathOption 

type BuildPathOption func(*buildPathOptions)

BuildPathOption configures path construction.

func WithOmitFields 

func WithOmitFields(fields ...string) BuildPathOption

WithOmitFields excludes fields from generated query parameters.

func WithQueryParams 

func WithQueryParams() BuildPathOption

WithQueryParams appends request fields that are not bound in the path as query parameters.

type CORSConfig added in v0.0.7 

type CORSConfig struct {
	Enabled bool

	AllowedOrigins []string
	AllowedMethods []string
	AllowedHeaders []string
	ExposedHeaders []string

	AllowCredentials bool
	MaxAge           time.Duration
}

CORSConfig configures the built-in HTTP CORS filter.

type CallOption 

type CallOption interface {
	// contains filtered or unexported methods
}

CallOption configures a Call before it starts or extracts information from a Call after it completes.

func Accept 

func Accept(contentType string) CallOption

Accept sets the request Accept header.

func ContentType 

func ContentType(contentType string) CallOption

ContentType with request content type. 

func Header(header *http.Header) CallOption

Header returns a CallOptions that retrieves the http response header from server reply.

func Operation 

func Operation(operation string) CallOption

Operation is serviceMethod call option

func PathTemplate 

func PathTemplate(pattern string) CallOption

PathTemplate is http path template

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is an HTTP client.

func NewClient 

func NewClient(ctx context.Context, opts ...ClientOption) (*Client, error)

NewClient returns an HTTP client.

func (*Client) Close 

func (client *Client) Close() error

Close tears down the Transport and all underlying connections.

func (*Client) Do 

func (client *Client) Do(req *http.Request, opts ...CallOption) (*http.Response, error)

Do send an HTTP request and decodes the body of response into target. returns an error (of type *Error) if the response status code is not 2xx.

func (*Client) Invoke 

func (client *Client) Invoke(ctx context.Context, method, path string, args any, reply any, opts ...CallOption) error

Invoke makes a rpc call procedure for remote service.

func (*Client) ServerSentEvent 

func (client *Client) ServerSentEvent(ctx context.Context, method, path string, args any, opts ...CallOption) (ClientStream, error)

ServerSentEvent opens an HTTP server-streaming call and receives replies as SSE events.

func (*Client) WebSocket 

func (client *Client) WebSocket(ctx context.Context, path string, opts ...CallOption) (ClientStream, error)

WebSocket opens an HTTP bidirectional streaming call over WebSocket.

type ClientOption 

type ClientOption func(*clientOptions)

ClientOption is HTTP client option.

func WithBlock 

func WithBlock() ClientOption

WithBlock with client block.

func WithDiscovery 

func WithDiscovery(d registry.Discovery) ClientOption

WithDiscovery with client discovery.

func WithEndpoint 

func WithEndpoint(endpoint string) ClientOption

WithEndpoint with client addr.

func WithErrorDecoder 

func WithErrorDecoder(errorDecoder DecodeErrorFunc) ClientOption

WithErrorDecoder with client error decoder.

func WithMiddleware 

func WithMiddleware(m ...middleware.Middleware) ClientOption

WithMiddleware with client middleware.

func WithNodeFilter 

func WithNodeFilter(filters ...selector.NodeFilter) ClientOption

WithNodeFilter with select filters

func WithRequestEncoder 

func WithRequestEncoder(encoder EncodeRequestFunc) ClientOption

WithRequestEncoder with client request encoder.

func WithResponseDecoder 

func WithResponseDecoder(decoder DecodeResponseFunc) ClientOption

WithResponseDecoder with client response decoder.

func WithSubset 

func WithSubset(size int) ClientOption

WithSubset with client discovery subset size. zero value means subset filter disabled

func WithTLSConfig 

func WithTLSConfig(c *tls.Config) ClientOption

WithTLSConfig with tls config.

func WithTimeout 

func WithTimeout(d time.Duration) ClientOption

WithTimeout with client request timeout.

func WithTransport 

func WithTransport(trans http.RoundTripper) ClientOption

WithTransport with client transport.

func WithUserAgent 

func WithUserAgent(ua string) ClientOption

WithUserAgent with client user agent.

type ClientStream 

type ClientStream interface {
	grpc.ClientStream
	Send(any) error
	Recv(any) error
	CloseAndRecv(any) error
}

ClientStream adapts HTTP streaming clients to grpc generated stream interfaces.

type ContentTypeCallOption 

type ContentTypeCallOption struct {
	EmptyCallOption
	ContentType string
}

ContentTypeCallOption is BodyCallOption

type Context 

type Context interface {
	context.Context
	Vars() url.Values
	Query() url.Values
	Form() url.Values
	Header() http.Header
	Request() *http.Request
	Response() http.ResponseWriter
	Middleware(middleware.Handler) middleware.Handler
	Bind(any) error
	BindVars(any) error
	BindQuery(any) error
	BindForm(any) error
	Returns(any, error) error
	Result(int, any) error
	JSON(int, any) error
	XML(int, any) error
	String(int, string) error
	Blob(int, string, []byte) error
	Stream(int, string, io.Reader) error
	Reset(http.ResponseWriter, *http.Request)
}

Context is an HTTP Context.

type DecodeErrorFunc 

type DecodeErrorFunc func(ctx context.Context, res *http.Response) error

DecodeErrorFunc is decode error func.

type DecodeRequestFunc 

type DecodeRequestFunc func(*http.Request, any) error

DecodeRequestFunc is decode request func.

type DecodeResponseFunc 

type DecodeResponseFunc func(ctx context.Context, res *http.Response, out any) error

DecodeResponseFunc is response decode func.

type EmptyCallOption 

type EmptyCallOption struct{}

EmptyCallOption does not alter the Call configuration. It can be embedded in another structure to carry satellite data for use by interceptors.

type EncodeErrorFunc 

type EncodeErrorFunc func(http.ResponseWriter, *http.Request, error)

EncodeErrorFunc is encode error func.

type EncodeRequestFunc 

type EncodeRequestFunc func(ctx context.Context, contentType string, in any) (body []byte, err error)

EncodeRequestFunc is request encode func.

type EncodeResponseFunc 

type EncodeResponseFunc func(http.ResponseWriter, *http.Request, any) error

EncodeResponseFunc is encode response func.

type ErrorResponse 

type ErrorResponse struct {
	Code      string         `json:"code" yaml:"code"`
	Message   string         `json:"message" yaml:"message"`
	RequestID string         `json:"request_id,omitempty" yaml:"request_id,omitempty"`
	TraceID   string         `json:"trace_id,omitempty" yaml:"trace_id,omitempty"`
	Metadata  map[string]any `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}

ErrorResponse is the transport-safe HTTP representation of an errorx error. HTTP status stays in the response status code; Code is the stable business code.

func ErrorResponseFromError 

func ErrorResponseFromError(err error) ErrorResponse

type FilterFunc 

type FilterFunc func(http.Handler) http.Handler

FilterFunc is a function which receives a http.Handler and returns another http.Handler.

func CORSFilter added in v0.0.7 

func CORSFilter(cfg CORSConfig) FilterFunc

CORSFilter returns a standard net/http middleware implementing browser CORS preflight and response headers. It is also exported so apps can use it with the generic Filter option when needed.

func FilterChain 

func FilterChain(filters ...FilterFunc) FilterFunc

FilterChain returns a FilterFunc that specifies the chained handler for HTTP Router.

type Flusher 

type Flusher = http.Flusher

Flusher type net/http

type HandlerFunc 

type HandlerFunc func(Context) error

HandlerFunc defines a function to serve HTTP requests.

type HeaderCallOption 

type HeaderCallOption struct {
	EmptyCallOption
	// contains filtered or unexported fields
}

HeaderCallOption is retrieve response header for client call

type OperationCallOption 

type OperationCallOption struct {
	EmptyCallOption
	Operation string
}

OperationCallOption is set ServiceMethod for client call

type PathTemplateCallOption 

type PathTemplateCallOption struct {
	EmptyCallOption
	Pattern string
}

PathTemplateCallOption is set path template for client call

type Redirector 

type Redirector interface {
	error
	Redirect() (string, int)
}

Redirector replies to the request with a redirect to url which may be a path relative to the request path.

func NewRedirect 

func NewRedirect(url string, code int) Redirector

NewRedirect new a redirect with url, which may be a path relative to the request path. The provided code should be in the 3xx range and is usually StatusMovedPermanently, StatusFound or StatusSeeOther. If the Content-Type header has not been set, Redirect sets it to "text/html; charset=utf-8" and writes a small HTML body. Setting the Content-Type header to any value, including nil, disables that behavior.

type Request 

type Request = http.Request

Request type net/http.

type ResponseController 

type ResponseController = http.ResponseController

type ResponseTransporter 

type ResponseTransporter interface {
	Transporter
	Response() http.ResponseWriter
}

ResponseTransporter extends Transporter with HTTP response access This interface provides access to the http.ResponseWriter for use cases like file downloads, streaming responses, or direct response manipulation.

type ResponseWriter 

type ResponseWriter = http.ResponseWriter

ResponseWriter type net/http.

type RouteInfo 

type RouteInfo struct {
	Path   string
	Method string
}

RouteInfo is an HTTP route info.

type Router 

type Router struct {
	// contains filtered or unexported fields
}

Router is an HTTP router.

func (*Router) CONNECT 

func (r *Router) CONNECT(path string, h HandlerFunc, m ...FilterFunc)

CONNECT registers a new CONNECT route for a path with matching handler in the router.

func (*Router) DELETE 

func (r *Router) DELETE(path string, h HandlerFunc, m ...FilterFunc)

DELETE registers a new DELETE route for a path with matching handler in the router.

func (*Router) GET 

func (r *Router) GET(path string, h HandlerFunc, m ...FilterFunc)

GET registers a new GET route for a path with matching handler in the router.

func (*Router) Group 

func (r *Router) Group(prefix string, filters ...FilterFunc) *Router

Group returns a new router group.

func (*Router) HEAD 

func (r *Router) HEAD(path string, h HandlerFunc, m ...FilterFunc)

HEAD registers a new HEAD route for a path with matching handler in the router.

func (*Router) Handle 

func (r *Router) Handle(method, relativePath string, h HandlerFunc, filters ...FilterFunc)

Handle registers a new route with a matcher for the URL path and method.

func (*Router) OPTIONS 

func (r *Router) OPTIONS(path string, h HandlerFunc, m ...FilterFunc)

OPTIONS registers a new OPTIONS route for a path with matching handler in the router.

func (*Router) PATCH 

func (r *Router) PATCH(path string, h HandlerFunc, m ...FilterFunc)

PATCH registers a new PATCH route for a path with matching handler in the router.

func (*Router) POST 

func (r *Router) POST(path string, h HandlerFunc, m ...FilterFunc)

POST registers a new POST route for a path with matching handler in the router.

func (*Router) PUT 

func (r *Router) PUT(path string, h HandlerFunc, m ...FilterFunc)

PUT registers a new PUT route for a path with matching handler in the router.

func (*Router) TRACE 

func (r *Router) TRACE(path string, h HandlerFunc, m ...FilterFunc)

TRACE registers a new TRACE route for a path with matching handler in the router.

type Server 

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

Server is an HTTP server wrapper.

func NewServer 

func NewServer(opts ...ServerOption) *Server

NewServer creates an HTTP server by options.

func (*Server) Endpoint 

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

Endpoint return a real address to registry endpoint. examples: 

https://127.0.0.1:8000
Legacy: http://127.0.0.1:8000?isSecure=false

func (*Server) Handle 

func (s *Server) Handle(path string, h http.Handler)

Handle registers a new route with a matcher for the URL path.

func (*Server) HandleFunc 

func (s *Server) HandleFunc(path string, h http.HandlerFunc)

HandleFunc registers a new route with a matcher for the URL path.

func (*Server) HandleHeader 

func (s *Server) HandleHeader(key, val string, h http.HandlerFunc)

HandleHeader registers a new route with a matcher for the header.

func (*Server) HandlePrefix 

func (s *Server) HandlePrefix(prefix string, h http.Handler)

HandlePrefix registers a new route with a matcher for the URL path prefix.

func (*Server) Route 

func (s *Server) Route(prefix string, filters ...FilterFunc) *Router

Route registers an HTTP router.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(res http.ResponseWriter, req *http.Request)

ServeHTTP should write reply headers and data to the ResponseWriter and then return.

func (*Server) Start 

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

Start start the HTTP server.

func (*Server) Stop 

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

Stop stop the HTTP server.

func (*Server) Use 

func (s *Server) Use(selector string, m ...middleware.Middleware)

Use uses a service middleware with selector. selector:

  • '/*'
  • '/helloworld.v1.Greeter/*'
  • '/helloworld.v1.Greeter/SayHello'

func (*Server) WalkHandle 

func (s *Server) WalkHandle(handle func(method, path string, handler http.HandlerFunc)) error

WalkHandle walks the router and all its sub-routers, calling walkFn for each route in the tree.

func (*Server) WalkRoute 

func (s *Server) WalkRoute(fn WalkRouteFunc) error

WalkRoute walks the router and all its sub-routers, calling walkFn for each route in the tree.

type ServerOption 

type ServerOption func(*Server)

ServerOption is an HTTP server option.

func AccessLog added in v0.0.5 

func AccessLog(cfg logx.AccessLogConfig) ServerOption

AccessLog configures the built-in HTTP access log middleware. Pass logx.AccessLogConfig{Enabled:false} to disable it explicitly.

func Address 

func Address(addr string) ServerOption

Address with server address.

func CORS added in v0.0.7 

func CORS(cfg CORSConfig) ServerOption

CORS installs a CORS filter. Unlike Filter(...), it appends to the existing filter chain so callers can combine it safely with authn/custom filters.

func Endpoint 

func Endpoint(endpoint *url.URL) ServerOption

Endpoint with server address.

func ErrorEncoder 

func ErrorEncoder(en EncodeErrorFunc) ServerOption

ErrorEncoder with error encoder.

func Filter 

func Filter(filters ...FilterFunc) ServerOption

Filter with HTTP middleware option.

func Listener 

func Listener(lis net.Listener) ServerOption

Listener with server lis

func Logger added in v0.0.5 

func Logger(logger logx.Logger) ServerOption

Logger sets the logx logger used by built-in HTTP access/error logs.

func MethodNotAllowedHandler 

func MethodNotAllowedHandler(handler http.Handler) ServerOption

func Metrics added in v0.0.5 

func Metrics(m metricsx.Manager) ServerOption

Metrics enables built-in low-cardinality HTTP server metrics.

func Middleware 

func Middleware(m ...middleware.Middleware) ServerOption

Middleware with service middleware option.

func Network 

func Network(network string) ServerOption

Network with server network.

func NotFoundHandler 

func NotFoundHandler(handler http.Handler) ServerOption

func PathPrefix 

func PathPrefix(prefix string) ServerOption

PathPrefix with mux's PathPrefix, router will be replaced by a subrouter that start with prefix.

func RequestDecoder 

func RequestDecoder(dec DecodeRequestFunc) ServerOption

RequestDecoder with request decoder.

func RequestQueryDecoder 

func RequestQueryDecoder(dec DecodeRequestFunc) ServerOption

RequestQueryDecoder with request decoder.

func RequestVarsDecoder 

func RequestVarsDecoder(dec DecodeRequestFunc) ServerOption

RequestVarsDecoder with request decoder.

func ResponseEncoder 

func ResponseEncoder(en EncodeResponseFunc) ServerOption

ResponseEncoder with response encoder.

func StrictSlash 

func StrictSlash(strictSlash bool) ServerOption

StrictSlash is with mux's StrictSlash If true, when the path pattern is "/path/", accessing "/path" will redirect to the former and vice versa.

func TLSConfig 

func TLSConfig(c *tls.Config) ServerOption

TLSConfig with TLS config.

func Timeout 

func Timeout(timeout time.Duration) ServerOption

Timeout with server timeout.

type ServerStream 

type ServerStream interface {
	grpc.ServerStream
	Send(any) error
	Recv(any) error
	SendAndClose(any) error
	Close(error) error
	SetContext(context.Context)
	SetReadDeadline(t time.Time) error
	SetWriteDeadline(t time.Time) error
}

ServerStream adapts HTTP streaming transports to grpc generated stream interfaces.

func NewServerSentEventServerStream 

func NewServerSentEventServerStream(ctx Context) ServerStream

NewServerSentEventServerStream returns a stream that writes server messages as SSE events.

func NewWebSocketServerStream 

func NewWebSocketServerStream(ctx Context, opts ...ServerStreamOption) (ServerStream, error)

NewWebSocketServerStream upgrades the current request and returns a WebSocket stream.

type ServerStreamOption 

type ServerStreamOption func(*serverStream)

ServerStreamOption customizes a server stream created by the HTTP transport.

func WithStreamBodyField 

func WithStreamBodyField(name string) ServerStreamOption

WithStreamBodyField declares the request message field that carries each streamed frame's payload. It is used for client-streaming RPCs whose HTTP rule maps a named body field (e.g. body: "data"): every received frame is decoded into that field while the remaining fields are bound from the request query and path vars.

type Target 

type Target struct {
	Scheme    string
	Authority string
	Endpoint  string
}

Target is resolver target

type Transport 

type Transport struct {
	// contains filtered or unexported fields
}

Transport is an HTTP transport.

func (*Transport) Endpoint 

func (tr *Transport) Endpoint() string

Endpoint returns the transport endpoint.

func (*Transport) Kind 

func (tr *Transport) Kind() transport.Kind

Kind returns the transport kind.

func (*Transport) Operation 

func (tr *Transport) Operation() string

Operation returns the transport operation.

func (*Transport) PathTemplate 

func (tr *Transport) PathTemplate() string

PathTemplate returns the http path template.

func (*Transport) ReplyHeader 

func (tr *Transport) ReplyHeader() transport.Header

ReplyHeader returns the reply header.

func (*Transport) Request 

func (tr *Transport) Request() *http.Request

Request returns the HTTP request.

func (*Transport) RequestHeader 

func (tr *Transport) RequestHeader() transport.Header

RequestHeader returns the request header.

func (*Transport) Response 

func (tr *Transport) Response() http.ResponseWriter

Response returns the HTTP response.

type Transporter 

type Transporter interface {
	transport.Transporter
	Request() *http.Request
	PathTemplate() string
}

Transporter is http Transporter

type WalkRouteFunc 

type WalkRouteFunc func(RouteInfo) error

WalkRouteFunc is the type of the function called for each route visited by Walk.

Source Files

View all Source files

Directories

Path Synopsis

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.