Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

restfulwrapper

package module

Go to main page

Versions in this module

v0

v0.1.4

Mar 12, 2026

v0.1.3

Jan 2, 2026

v0.1.2

Dec 30, 2025

Changes in this version

+ type ErrorHandler func(err error) error

type RestfulWrapper

+ func (r *RestfulWrapper) ErrorHandler(errorHandler ErrorHandler) *RestfulWrapper

v0.1.1

Oct 30, 2025

v0.1.0

Oct 29, 2025

Changes in this version

+ func NewAPIBodyError(bodyError error) error

+ func NewAPIHeaderParameterError(parameter string, parameterError error) error

+ func NewAPIPathParameterError(parameter string, parameterError error) error

+ func NewAPIQueryParameterError(parameter string, parameterError error) error

+ func NewAPIResponseError(code int, message string) error

+ func Register(apiTagKey string, f RegisterFunction)

+ type APIBodyError struct

+ func (e *APIBodyError) Error() string

+ func (e *APIBodyError) Unwrap() []error

+ func (e *APIBodyError) WriteError(resp *restful.Response)

+ type APIHeaderParameterError struct

+ func (e *APIHeaderParameterError) Error() string

+ func (e *APIHeaderParameterError) Unwrap() []error

+ func (e *APIHeaderParameterError) WriteError(resp *restful.Response)

+ type APIHeaderParameterErrorOutput struct

+ Parameter string

+ type APIPathParameterError struct

+ func (e *APIPathParameterError) Error() string

+ func (e *APIPathParameterError) Unwrap() []error

+ func (e *APIPathParameterError) WriteError(resp *restful.Response)

+ type APIPathParameterErrorOutput struct

+ Parameter string

+ type APIQueryParameterError struct

+ func (e *APIQueryParameterError) Error() string

+ func (e *APIQueryParameterError) Unwrap() []error

+ func (e *APIQueryParameterError) WriteError(resp *restful.Response)

+ type APIQueryParameterErrorOutput struct

+ Parameter string

+ type APIResponseError struct

+ func (e *APIResponseError) Code() int

+ func (e *APIResponseError) Error() string

+ func (e *APIResponseError) Unwrap() error

+ func (e *APIResponseError) WriteError(resp *restful.Response)

+ type APIResponseErrorOutput struct

+ Message string

+ Type string

+ type ContextAction func(ctx context.Context, info *RestfulFunctionInfo) context.Context

+ type ErrorWriter interface

+ WriteError func(resp *restful.Response)

+ type HTTPMethodDELETE struct

+ type HTTPMethodGET struct

+ type HTTPMethodOPTIONS struct

+ type HTTPMethodPATCH struct

+ type HTTPMethodPOST struct

+ type HTTPMethodPUT struct

+ type InputField struct

+ Function InputFieldFunction

+ Name string

+ type InputFieldFunction func(v reflect.Value, req *restful.Request, metadataValue reflect.Value) error

+ type ParameterParser interface

+ ParseString func(input string) error

+ type RegisterFunction func(apiTagValue string, field reflect.StructField, info *RestfulFunctionInfo) (InputFieldFunction, error)

+ type RestfulFunctionHeaderParameter struct

+ AllowMultiple bool

+ Description string

+ FieldName string

+ Name string

+ type RestfulFunctionInfo struct

+ BodyExample any

+ Consumes []string

+ Do []func(*restful.RouteBuilder)

+ Doc string

+ FunctionValue reflect.Value

+ HTTPMethod string

+ HTTPPath string

+ HeaderParameters []RestfulFunctionHeaderParameter

+ InContextPosition int

+ InMetadataPosition int

+ InMetadataType reflect.Type

+ InputFields []InputField

+ LocalMap map[string]string

+ Notes string

+ OutErrorPosition int

+ OutResponsePosition int

+ PathParameters []RestfulFunctionPathParameter

+ Produces []string

+ QueryParameters []RestfulFunctionQueryParameter

+ ResponseExample any

+ func ParseRestfulFunction(f interface{}) (*RestfulFunctionInfo, error)

+ func (info *RestfulFunctionInfo) CreateFunctionWithError() RestfulFunctionWithError

+ func (info *RestfulFunctionInfo) UpdateRouteBuilder(routeBuilder *restful.RouteBuilder)

+ type RestfulFunctionPathParameter struct

+ Description string

+ FieldName string

+ Name string

+ type RestfulFunctionQueryParameter struct

+ AllowMultiple bool

+ Description string

+ FieldName string

+ Name string

+ type RestfulFunctionWithError func(req *restful.Request, resp *restful.Response) error

+ type RestfulRouteWrapper struct

+ func (r *RestfulRouteWrapper) Consumes(contentTypes ...string) *RestfulRouteWrapper

+ func (r *RestfulRouteWrapper) Do(doFunctions ...func(*restful.RouteBuilder)) *RestfulRouteWrapper

+ func (r *RestfulRouteWrapper) Path(path string) *RestfulRouteWrapper

+ func (r *RestfulRouteWrapper) Produces(contentTypes ...string) *RestfulRouteWrapper

+ func (r *RestfulRouteWrapper) RouteBuilder() *restful.RouteBuilder

+ type RestfulWrapper struct

+ func WebService(path string) *RestfulWrapper

+ func (r *RestfulWrapper) Attributes(attributes map[string]any) *RestfulWrapper

+ func (r *RestfulWrapper) Consumes(contentTypes ...string) *RestfulWrapper

+ func (r *RestfulWrapper) DELETE(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) Do(doFunctions ...func(*restful.RouteBuilder)) *RestfulWrapper

+ func (r *RestfulWrapper) GET(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) Method(method string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) OPTIONS(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) PATCH(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) POST(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) PUT(path string) *RestfulRouteWrapper

+ func (r *RestfulWrapper) Produces(contentTypes ...string) *RestfulWrapper

+ func (r *RestfulWrapper) Register(ctx context.Context, path string, f interface{})

+ func (r *RestfulWrapper) Route(routeBuilders ...*restful.RouteBuilder) *RestfulWrapper

+ func (r *RestfulWrapper) Session() *RestfulWrapper

+ func (r *RestfulWrapper) WebService() *restful.WebService

+ func (w *RestfulWrapper) ContextAction(f ...ContextAction) *RestfulWrapper

+ type Writer interface

+ Write func(*restful.Response)