restful

Mar 11, 2024

Changes in this version

type CompressingResponseWriter

+ func (c *CompressingResponseWriter) Flush()

Aug 19, 2023

Changes in this version

type Route

+ WriteSamples []interface{}

Mar 9, 2023

Changes in this version

+ var MergePathStrategy = PathJoinStrategy

+ var PathJoinStrategy = func(rootPath, routePath string) string

+ var TrimSlashStrategy = func(rootPath, routePath string) string

+ type MergePathStrategyFunc func(rootPath, routePath string) string

Nov 11, 2022

Changes in this version

+ const HEADER_ContentDisposition

+ const MIME_ZIP

+ var TrimRightSlashEnabled = false

Jul 21, 2022

Changes in this version

+ const MultiPartFormParameterKind

type FilterFunction

+ func HttpMiddlewareHandlerToFilter(middleware HttpMiddlewareHandler) FilterFunction

+ type HttpMiddlewareHandler func(http.Handler) http.Handler

type Parameter

+ func MultiPartFormParameter(name, description string) *Parameter

type WebService

+ func (w *WebService) MultiPartFormParameter(name, description string) *Parameter

Jun 6, 2022

Changes in this version

type CrossOriginResourceSharing

+ AllowedDomainFunc func(origin string) bool

Mar 8, 2022 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Dec 5, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

type Parameter

+ func (p *Parameter) PossibleValues(values []string) *Parameter

type ParameterData

+ PossibleValues []string

Nov 24, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Oct 4, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Sep 24, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

type FilterChain

+ Operation string

+ ParameterDocs []*Parameter

type Parameter

+ func (p *Parameter) AddExtension(key string, value interface{}) *Parameter

+ func (p *Parameter) AllowEmptyValue(multiple bool) *Parameter

+ func (p *Parameter) MaxItems(maxItems int64) *Parameter

+ func (p *Parameter) MaxLength(maxLength int64) *Parameter

+ func (p *Parameter) Maximum(maximum float64) *Parameter

+ func (p *Parameter) MinItems(minItems int64) *Parameter

+ func (p *Parameter) MinLength(minLength int64) *Parameter

+ func (p *Parameter) Minimum(minimum float64) *Parameter

+ func (p *Parameter) Pattern(pattern string) *Parameter

+ func (p *Parameter) UniqueItems(uniqueItems bool) *Parameter

type ParameterData

+ AllowEmptyValue bool

+ MaxItems *int64

+ MaxLength *int64

+ Maximum *float64

+ MinItems *int64

+ MinLength *int64

+ Minimum *float64

+ Pattern string

+ UniqueItems bool

Sep 18, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

+ type ExtensionProperties struct

+ Extensions map[string]interface{}

+ func (ep *ExtensionProperties) AddExtension(key string, value interface{})

type RouteBuilder

+ func (b *RouteBuilder) AddExtension(key string, value interface{}) *RouteBuilder

Jul 14, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Apr 12, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Apr 10, 2021 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

type Request

+ func (r Request) SelectedRoute() RouteReader

+ type RouteReader interface

+ Consumes func() []string

+ Deprecated func() bool

+ Doc func() string

+ Metadata func() map[string]interface{}

+ Method func() string

+ Notes func() string

+ Operation func() string

+ ParameterDocs func() []*Parameter

+ Path func() string

Nov 10, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

type WebService

+ func (w *WebService) OPTIONS(subPath string) *RouteBuilder

Oct 23, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Aug 31, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Aug 19, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Jun 21, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

type RouteBuilder

+ func (b *RouteBuilder) AllowedMethodsWithoutContentType(methods []string) *RouteBuilder

type ServiceError

+ Header http.Header

+ func NewErrorWithHeader(code int, message string, header http.Header) ServiceError

Mar 9, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

+ type Header struct

+ Description string

+ type Items struct

+ CollectionFormat string

+ Default interface{}

+ Format string

+ Items *Items

+ Type string

type ResponseError

+ Headers map[string]Header

type RouteBuilder

+ func (b *RouteBuilder) ReturnsWithHeaders(code int, message string, model interface{}, headers map[string]Header) *RouteBuilder

Jan 29, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Jan 12, 2020 GO-2022-0619

  GO-2022-0619: Authorization bypass in github.com/emicklei/go-restful, go-restful/v2 and go-restful/v3

Changes in this version

+ const BodyParameterKind

+ const CollectionFormatCSV

+ const CollectionFormatMulti

+ const CollectionFormatPipes

+ const CollectionFormatSSV

+ const CollectionFormatTSV

+ const ENCODING_DEFLATE

+ const ENCODING_GZIP

+ const FormParameterKind

+ const HEADER_Accept

+ const HEADER_AcceptEncoding

+ const HEADER_AccessControlAllowCredentials

+ const HEADER_AccessControlAllowHeaders

+ const HEADER_AccessControlAllowMethods

+ const HEADER_AccessControlAllowOrigin

+ const HEADER_AccessControlExposeHeaders

+ const HEADER_AccessControlMaxAge

+ const HEADER_AccessControlRequestHeaders

+ const HEADER_AccessControlRequestMethod

+ const HEADER_Allow

+ const HEADER_ContentEncoding

+ const HEADER_ContentType

+ const HEADER_LastModified

+ const HEADER_Origin

+ const HeaderParameterKind

+ const MIME_JSON

+ const MIME_OCTET

+ const MIME_XML

+ const PathParameterKind

+ const QueryParameterKind

+ var DefaultResponseMimeType string

+ var DoNotRecover = false

+ var EnableContentEncoding = false

+ var MarshalIndent = json.MarshalIndent

+ var NewDecoder = json.NewDecoder

+ var NewEncoder = json.NewEncoder

+ var PrettyPrintResponses = true

+ func Add(service *WebService)

+ func DefaultRequestContentType(mime string)

+ func DefaultResponseContentType(mime string)

+ func EnableTracing(enabled bool)

+ func Filter(filter FilterFunction)

+ func NoBrowserCacheFilter(req *Request, resp *Response, chain *FilterChain)

+ func RegisterEntityAccessor(mime string, erw EntityReaderWriter)

+ func SetCompressorProvider(p CompressorProvider)

+ func SetLogger(customLogger log.StdLogger)

+ func TraceLogger(logger log.StdLogger)

+ type BoundedCachedCompressors struct

+ func NewBoundedCachedCompressors(writersCapacity, readersCapacity int) *BoundedCachedCompressors

+ func (b *BoundedCachedCompressors) AcquireGzipReader() *gzip.Reader

+ func (b *BoundedCachedCompressors) AcquireGzipWriter() *gzip.Writer

+ func (b *BoundedCachedCompressors) AcquireZlibWriter() *zlib.Writer

+ func (b *BoundedCachedCompressors) ReleaseGzipReader(r *gzip.Reader)

+ func (b *BoundedCachedCompressors) ReleaseGzipWriter(w *gzip.Writer)

+ func (b *BoundedCachedCompressors) ReleaseZlibWriter(w *zlib.Writer)

+ type CollectionFormat string

+ func (cf CollectionFormat) String() string

+ type CompressingResponseWriter struct

+ func NewCompressingResponseWriter(httpWriter http.ResponseWriter, encoding string) (*CompressingResponseWriter, error)

+ func (c *CompressingResponseWriter) Close() error

+ func (c *CompressingResponseWriter) CloseNotify() <-chan bool

+ func (c *CompressingResponseWriter) Header() http.Header

+ func (c *CompressingResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

+ func (c *CompressingResponseWriter) Write(bytes []byte) (int, error)

+ func (c *CompressingResponseWriter) WriteHeader(status int)

+ type CompressorProvider interface

+ AcquireGzipReader func() *gzip.Reader

+ AcquireGzipWriter func() *gzip.Writer

+ AcquireZlibWriter func() *zlib.Writer

+ ReleaseGzipReader func(w *gzip.Reader)

+ ReleaseGzipWriter func(w *gzip.Writer)

+ ReleaseZlibWriter func(w *zlib.Writer)

+ func CurrentCompressorProvider() CompressorProvider

+ type Container struct

+ ServeMux *http.ServeMux

+ var DefaultContainer *Container

+ func NewContainer() *Container

+ func (c *Container) Add(service *WebService) *Container

+ func (c *Container) Dispatch(httpWriter http.ResponseWriter, httpRequest *http.Request)

+ func (c *Container) DoNotRecover(doNot bool)

+ func (c *Container) EnableContentEncoding(enabled bool)

+ func (c *Container) Filter(filter FilterFunction)

+ func (c *Container) Handle(pattern string, handler http.Handler)

+ func (c *Container) HandleWithFilter(pattern string, handler http.Handler)

+ func (c *Container) OPTIONSFilter(req *Request, resp *Response, chain *FilterChain)

+ func (c *Container) RecoverHandler(handler RecoverHandleFunction)

+ func (c *Container) RegisteredWebServices() []*WebService

+ func (c *Container) Remove(ws *WebService) error

+ func (c *Container) Router(aRouter RouteSelector)

+ func (c *Container) ServeHTTP(httpwriter http.ResponseWriter, httpRequest *http.Request)

+ func (c *Container) ServiceErrorHandler(handler ServiceErrorHandleFunction)

+ type CrossOriginResourceSharing struct

+ AllowedDomains []string

+ AllowedHeaders []string

+ AllowedMethods []string

+ Container *Container

+ CookiesAllowed bool

+ ExposeHeaders []string

+ MaxAge int

+ func (c CrossOriginResourceSharing) Filter(req *Request, resp *Response, chain *FilterChain)

+ type CurlyRouter struct

+ func (c CurlyRouter) SelectRoute(webServices []*WebService, httpRequest *http.Request) (selectedService *WebService, selected *Route, err error)

+ type EntityReaderWriter interface

+ Read func(req *Request, v interface{}) error

+ Write func(resp *Response, status int, v interface{}) error

+ func NewEntityAccessorJSON(contentType string) EntityReaderWriter

+ func NewEntityAccessorXML(contentType string) EntityReaderWriter

+ type FilterChain struct

+ Filters []FilterFunction

+ Index int

+ Target RouteFunction

+ func (f *FilterChain) ProcessFilter(request *Request, response *Response)

+ type FilterFunction func(*Request, *Response, *FilterChain)

+ func OPTIONSFilter() FilterFunction

+ type Parameter struct

+ func BodyParameter(name, description string) *Parameter

+ func FormParameter(name, description string) *Parameter

+ func HeaderParameter(name, description string) *Parameter

+ func PathParameter(name, description string) *Parameter

+ func QueryParameter(name, description string) *Parameter

+ func (p *Parameter) AllowMultiple(multiple bool) *Parameter

+ func (p *Parameter) AllowableValues(values map[string]string) *Parameter

+ func (p *Parameter) CollectionFormat(format CollectionFormat) *Parameter

+ func (p *Parameter) Data() ParameterData

+ func (p *Parameter) DataFormat(formatName string) *Parameter

+ func (p *Parameter) DataType(typeName string) *Parameter

+ func (p *Parameter) DefaultValue(stringRepresentation string) *Parameter

+ func (p *Parameter) Description(doc string) *Parameter

+ func (p *Parameter) Kind() int

+ func (p *Parameter) Required(required bool) *Parameter

+ type ParameterData struct

+ AllowMultiple bool

+ AllowableValues map[string]string

+ CollectionFormat string

+ DataFormat string

+ DataType string

+ DefaultValue string

+ Description string

+ Kind int

+ Name string

+ Required bool

+ type PathProcessor interface

+ ExtractParameters func(route *Route, webService *WebService, urlPath string) map[string]string

+ type RecoverHandleFunction func(interface{}, http.ResponseWriter)

+ type Request struct

+ Request *http.Request

+ func NewRequest(httpRequest *http.Request) *Request

+ func (r *Request) BodyParameter(name string) (string, error)

+ func (r *Request) HeaderParameter(name string) string

+ func (r *Request) PathParameter(name string) string

+ func (r *Request) PathParameters() map[string]string

+ func (r *Request) QueryParameter(name string) string

+ func (r *Request) QueryParameters(name string) []string

+ func (r *Request) ReadEntity(entityPointer interface{}) (err error)

+ func (r *Request) SetAttribute(name string, value interface{})

+ func (r Request) Attribute(name string) interface{}

+ func (r Request) SelectedRoutePath() string

+ type Response struct

+ func NewResponse(httpWriter http.ResponseWriter) *Response

+ func (r *Response) EntityWriter() (EntityReaderWriter, bool)

+ func (r *Response) Flush()

+ func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)

+ func (r *Response) PrettyPrint(bePretty bool)

+ func (r *Response) SetRequestAccepts(mime string)

+ func (r *Response) Write(bytes []byte) (int, error)

+ func (r *Response) WriteAsJson(value interface{}) error

+ func (r *Response) WriteAsXml(value interface{}) error

+ func (r *Response) WriteEntity(value interface{}) error

+ func (r *Response) WriteError(httpStatus int, err error) (writeErr error)

+ func (r *Response) WriteErrorString(httpStatus int, errorReason string) error

+ func (r *Response) WriteHeader(httpStatus int)

+ func (r *Response) WriteHeaderAndEntity(status int, value interface{}) error

+ func (r *Response) WriteHeaderAndJson(status int, value interface{}, contentType string) error

+ func (r *Response) WriteHeaderAndXml(status int, value interface{}) error

+ func (r *Response) WriteJson(value interface{}, contentType string) error

+ func (r *Response) WriteServiceError(httpStatus int, err ServiceError) error

+ func (r Response) AddHeader(header string, value string) Response

+ func (r Response) CloseNotify() <-chan bool

+ func (r Response) ContentLength() int

+ func (r Response) Error() error

+ func (r Response) InternalServerError() Response

+ func (r Response) StatusCode() int

+ type ResponseError struct

+ Code int

+ IsDefault bool

+ Message string

+ Model interface{}

+ type Route struct

+ Consumes []string

+ DefaultResponse *ResponseError

+ Deprecated bool

+ Doc string

+ Filters []FilterFunction

+ Function RouteFunction

+ If []RouteSelectionConditionFunction

+ Metadata map[string]interface{}

+ Method string

+ Notes string

+ Operation string

+ ParameterDocs []*Parameter

+ Path string

+ Produces []string

+ ReadSample interface{}

+ ResponseErrors map[int]ResponseError

+ WriteSample interface{}

+ func (r Route) EnableContentEncoding(enabled bool)

+ func (r Route) String() string

+ type RouteBuilder struct

+ func (b *RouteBuilder) Build() Route

+ func (b *RouteBuilder) Consumes(mimeTypes ...string) *RouteBuilder

+ func (b *RouteBuilder) ContentEncodingEnabled(enabled bool) *RouteBuilder

+ func (b *RouteBuilder) DefaultReturns(message string, model interface{}) *RouteBuilder

+ func (b *RouteBuilder) Deprecate() *RouteBuilder

+ func (b *RouteBuilder) Do(oneArgBlocks ...func(*RouteBuilder)) *RouteBuilder

+ func (b *RouteBuilder) Doc(documentation string) *RouteBuilder

+ func (b *RouteBuilder) Filter(filter FilterFunction) *RouteBuilder

+ func (b *RouteBuilder) If(condition RouteSelectionConditionFunction) *RouteBuilder

+ func (b *RouteBuilder) Metadata(key string, value interface{}) *RouteBuilder

+ func (b *RouteBuilder) Method(method string) *RouteBuilder

+ func (b *RouteBuilder) Notes(notes string) *RouteBuilder

+ func (b *RouteBuilder) Operation(name string) *RouteBuilder

+ func (b *RouteBuilder) Param(parameter *Parameter) *RouteBuilder

+ func (b *RouteBuilder) Path(subPath string) *RouteBuilder

+ func (b *RouteBuilder) Produces(mimeTypes ...string) *RouteBuilder

+ func (b *RouteBuilder) Reads(sample interface{}, optionalDescription ...string) *RouteBuilder

+ func (b *RouteBuilder) Returns(code int, message string, model interface{}) *RouteBuilder

+ func (b *RouteBuilder) ReturnsError(code int, message string, model interface{}) *RouteBuilder

+ func (b *RouteBuilder) To(function RouteFunction) *RouteBuilder

+ func (b *RouteBuilder) Writes(sample interface{}) *RouteBuilder

+ func (b RouteBuilder) ParameterNamed(name string) (p *Parameter)

+ type RouteFunction func(*Request, *Response)

+ type RouteSelectionConditionFunction func(httpRequest *http.Request) bool

+ type RouteSelector interface

+ SelectRoute func(webServices []*WebService, httpRequest *http.Request) (selectedService *WebService, selected *Route, err error)

+ type RouterJSR311 struct

+ func (r RouterJSR311) ExtractParameters(route *Route, webService *WebService, urlPath string) map[string]string

+ func (r RouterJSR311) SelectRoute(webServices []*WebService, httpRequest *http.Request) (selectedService *WebService, selectedRoute *Route, err error)

+ type ServiceError struct

+ Code int

+ Message string

+ func NewError(code int, message string) ServiceError

+ func (s ServiceError) Error() string

+ type ServiceErrorHandleFunction func(ServiceError, *Request, *Response)

+ type SyncPoolCompessors struct

+ GzipReaderPool *sync.Pool

+ GzipWriterPool *sync.Pool

+ ZlibWriterPool *sync.Pool

+ func NewSyncPoolCompessors() *SyncPoolCompessors

+ func (s *SyncPoolCompessors) AcquireGzipReader() *gzip.Reader

+ func (s *SyncPoolCompessors) AcquireGzipWriter() *gzip.Writer

+ func (s *SyncPoolCompessors) AcquireZlibWriter() *zlib.Writer

+ func (s *SyncPoolCompessors) ReleaseGzipReader(r *gzip.Reader)

+ func (s *SyncPoolCompessors) ReleaseGzipWriter(w *gzip.Writer)

+ func (s *SyncPoolCompessors) ReleaseZlibWriter(w *zlib.Writer)

+ type TypeNameHandleFunction func(sample interface{}) string

+ type WebService struct

+ func RegisteredWebServices() []*WebService

+ func (w *WebService) ApiVersion(apiVersion string) *WebService

+ func (w *WebService) BodyParameter(name, description string) *Parameter

+ func (w *WebService) Consumes(accepts ...string) *WebService

+ func (w *WebService) DELETE(subPath string) *RouteBuilder

+ func (w *WebService) Doc(plainText string) *WebService

+ func (w *WebService) Documentation() string

+ func (w *WebService) Filter(filter FilterFunction) *WebService

+ func (w *WebService) FormParameter(name, description string) *Parameter

+ func (w *WebService) GET(subPath string) *RouteBuilder

+ func (w *WebService) HEAD(subPath string) *RouteBuilder

+ func (w *WebService) HeaderParameter(name, description string) *Parameter

+ func (w *WebService) Method(httpMethod string) *RouteBuilder

+ func (w *WebService) PATCH(subPath string) *RouteBuilder

+ func (w *WebService) POST(subPath string) *RouteBuilder

+ func (w *WebService) PUT(subPath string) *RouteBuilder

+ func (w *WebService) Param(parameter *Parameter) *WebService

+ func (w *WebService) Path(root string) *WebService

+ func (w *WebService) PathParameter(name, description string) *Parameter

+ func (w *WebService) PathParameters() []*Parameter

+ func (w *WebService) Produces(contentTypes ...string) *WebService

+ func (w *WebService) QueryParameter(name, description string) *Parameter

+ func (w *WebService) RemoveRoute(path, method string) error

+ func (w *WebService) RootPath() string

+ func (w *WebService) Route(builder *RouteBuilder) *WebService

+ func (w *WebService) Routes() []Route

+ func (w *WebService) SetDynamicRoutes(enable bool)

+ func (w *WebService) TypeNameHandler(handler TypeNameHandleFunction) *WebService

+ func (w *WebService) Version() string