rest

Documentation

Index

• Constants
• Variables
• func BodyMaxBytes(n int64) func(inner http.Handler) http.Handler
• func BulkHead(workers int, maxWaitTime time.Duration) func(inner http.Handler) http.Handler
• func CallbackOnChange(listener *httpConfigListener) func(event *configmgr.NacosChangeEvent)
• func CopyReqBody(b io.ReadCloser) (r1, r2 io.ReadCloser, err error)
• func CopyRespBody(b *bytes.Buffer) (b1, b2 *bytes.Buffer, err error)
• func GetReqBody(cp io.ReadCloser, r *http.Request) string
• func GetRespBody(rec *httptest.ResponseRecorder) string
• func GetTranslator() ut.Translator
• func GetValidate() *validator.Validate
• func InitialiseRemoteConfigListener()
• func JsonMarshalIndent(data interface{}, prefix, indent string, disableHTMLEscape bool) (string, error)
• func NewHttpConfigListener() *httpConfigListener
• func NewResponseWriter(w http.ResponseWriter) *responseWriter
• func PrometheusMiddleware(next http.Handler) http.Handler
• func Proxy(proxyConfig ProxyConfig) func(inner http.Handler) http.Handler
• func SetTranslator(trans ut.Translator)
• func ValidateStruct(value interface{}) error
• func ValidateVar(value interface{}, tag, param string) error
• type BizError
  • func NewBizError(err error, opts ...BizErrorOption) BizError
  • func (b BizError) Error() string
  • func (b BizError) String() string
• type BizErrorOption
  • func WithCause(cause error) BizErrorOption
  • func WithErrCode(errCode int) BizErrorOption
  • func WithStatusCode(statusCode int) BizErrorOption
• type MiddlewareFunc
  • func (mw MiddlewareFunc) Middleware(handler http.Handler) http.Handler
• type ProxyConfig
• type ProxyTarget
• type RestServer
  • func NewRestServer(data ...map[string]interface{}) *RestServer
  • func (srv *RestServer) AddMiddleware(mwf ...func(http.Handler) http.Handler)
  • func (srv *RestServer) AddRoute(route ...Route)
  • func (srv *RestServer) PreMiddleware(mwf ...func(http.Handler) http.Handler)
  • func (srv *RestServer) Run()
• type Route

Constants

const (
	HeaderAccept              = "Accept"
	HeaderAcceptEncoding      = "Accept-Encoding"
	HeaderAllow               = "Allow"
	HeaderAuthorization       = "Authorization"
	HeaderContentDisposition  = "Content-Disposition"
	HeaderContentEncoding     = "Content-Encoding"
	HeaderContentLength       = "Content-Length"
	HeaderContentType         = "Content-Type"
	HeaderCookie              = "Cookie"
	HeaderSetCookie           = "Set-Cookie"
	HeaderIfModifiedSince     = "If-Modified-Since"
	HeaderLastModified        = "Last-Modified"
	HeaderLocation            = "Location"
	HeaderUpgrade             = "Upgrade"
	HeaderVary                = "Vary"
	HeaderWWWAuthenticate     = "WWW-Authenticate"
	HeaderXForwardedFor       = "X-Forwarded-For"
	HeaderXForwardedProto     = "X-Forwarded-Proto"
	HeaderXForwardedProtocol  = "X-Forwarded-Protocol"
	HeaderXForwardedSsl       = "X-Forwarded-Ssl"
	HeaderXUrlScheme          = "X-Url-Scheme"
	HeaderXHTTPMethodOverride = "X-HTTP-Method-Override"
	HeaderXRealIP             = "X-Real-IP"
	HeaderXRequestID          = "X-Request-ID"
	HeaderXRequestedWith      = "X-Requested-With"
	HeaderServer              = "Server"
	HeaderOrigin              = "Origin"

	// Access control
	HeaderAccessControlRequestMethod    = "Access-Control-Request-Method"
	HeaderAccessControlRequestHeaders   = "Access-Control-Request-Headers"
	HeaderAccessControlAllowOrigin      = "Access-Control-Allow-Origin"
	HeaderAccessControlAllowMethods     = "Access-Control-Allow-Methods"
	HeaderAccessControlAllowHeaders     = "Access-Control-Allow-Headers"
	HeaderAccessControlAllowCredentials = "Access-Control-Allow-Credentials"
	HeaderAccessControlExposeHeaders    = "Access-Control-Expose-Headers"
	HeaderAccessControlMaxAge           = "Access-Control-Max-Age"

	// Security
	HeaderStrictTransportSecurity         = "Strict-Transport-Security"
	HeaderXContentTypeOptions             = "X-Content-Type-Options"
	HeaderXXSSProtection                  = "X-XSS-Protection"
	HeaderXFrameOptions                   = "X-Frame-Options"
	HeaderContentSecurityPolicy           = "Content-Security-Policy"
	HeaderContentSecurityPolicyReportOnly = "Content-Security-Policy-Report-Only"
	HeaderXCSRFToken                      = "X-CSRF-Token"
	HeaderReferrerPolicy                  = "Referrer-Policy"
)

Headers borrowed from labstack/echo

Variables

var Oas string

Oas store OpenAPI3.0 description json string

var RunnerChain = goresilience.RunnerChain

Functions

func BodyMaxBytes

func BodyMaxBytes(n int64) func(inner http.Handler) http.Handler

func BulkHead

func BulkHead(workers int, maxWaitTime time.Duration) func(inner http.Handler) http.Handler

BulkHead add bulk head pattern middleware based on https://github.com/slok/goresilience workers is the number of workers in the execution pool. maxWaitTime is the max time an incoming request will wait to execute before being dropped its execution and return 429 response.

func CallbackOnChange

func CallbackOnChange(listener *httpConfigListener) func(event *configmgr.NacosChangeEvent)

func CopyReqBody

func CopyReqBody(b io.ReadCloser) (r1, r2 io.ReadCloser, err error)

borrowed from httputil unexported function drainBody

func CopyRespBody

func CopyRespBody(b *bytes.Buffer) (b1, b2 *bytes.Buffer, err error)

func GetReqBody

func GetReqBody(cp io.ReadCloser, r *http.Request) string

func GetRespBody

func GetRespBody(rec *httptest.ResponseRecorder) string

func GetTranslator

func GetTranslator() ut.Translator

func GetValidate

func GetValidate() *validator.Validate

func InitialiseRemoteConfigListener

func InitialiseRemoteConfigListener()

func JsonMarshalIndent

func JsonMarshalIndent(data interface{}, prefix, indent string, disableHTMLEscape bool) (string, error)

func NewHttpConfigListener

func NewHttpConfigListener() *httpConfigListener

func NewResponseWriter

func NewResponseWriter(w http.ResponseWriter) *responseWriter

NewResponseWriter creates new responseWriter

func PrometheusMiddleware

func PrometheusMiddleware(next http.Handler) http.Handler

PrometheusMiddleware returns http HandlerFunc for prometheus matrix

func Proxy

func Proxy(proxyConfig ProxyConfig) func(inner http.Handler) http.Handler

func SetTranslator

func SetTranslator(trans ut.Translator)

func ValidateStruct

func ValidateStruct(value interface{}) error

func ValidateVar

func ValidateVar(value interface{}, tag, param string) error

Types

type BizError

type BizError struct {
	StatusCode int
	ErrCode    int
	ErrMsg     string
	Cause      error
}

BizError is used for business error implemented error interface StatusCode will be set to http response status code ErrCode is used for business error code ErrMsg is custom error message

func NewBizError

func NewBizError(err error, opts ...BizErrorOption) BizError

NewBizError is factory function for creating an instance of BizError struct

func (BizError) Error

func (b BizError) Error() string

Error is used for implementing error interface

func (BizError) String

func (b BizError) String() string

String function is used for printing string representation of a BizError instance

type BizErrorOption

type BizErrorOption func(bizError *BizError)

func WithCause

func WithCause(cause error) BizErrorOption

func WithErrCode

func WithErrCode(errCode int) BizErrorOption

func WithStatusCode

func WithStatusCode(statusCode int) BizErrorOption

type MiddlewareFunc

type MiddlewareFunc func(http.Handler) http.Handler

func (MiddlewareFunc) Middleware

func (mw MiddlewareFunc) Middleware(handler http.Handler) http.Handler

Middleware allows MiddlewareFunc to implement the middleware interface.

type ProxyConfig

type ProxyConfig struct {
	ProviderStore cache.IStore
	// To customize the transport to remote.
	// Examples: If custom TLS certificates are required.
	Transport http.RoundTripper

	// ModifyResponse defines function to modify response from ProxyTarget.
	ModifyResponse func(*http.Response) error
}

type ProxyTarget

type ProxyTarget struct {
	Name string
	URL  *url.URL
}

type RestServer

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

RestServer wraps httpRouter router

func NewRestServer

func NewRestServer(data ...map[string]interface{}) *RestServer

NewRestServer create a RestServer instance

func (*RestServer) AddMiddleware

func (srv *RestServer) AddMiddleware(mwf ...func(http.Handler) http.Handler)

AddMiddleware adds middlewares to the end of chain

func (*RestServer) AddRoute

func (srv *RestServer) AddRoute(route ...Route)

AddRoute adds routes to router

func (*RestServer) PreMiddleware

func (srv *RestServer) PreMiddleware(mwf ...func(http.Handler) http.Handler)

PreMiddleware adds middlewares to the head of chain

func (*RestServer) Run

func (srv *RestServer) Run()

Run runs http server

type Route

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

Route wraps config for route