httpx

package

v0.0.0-...-1d624c0 Latest Latest Go to latest Published: May 12, 2025 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/MarkdownNinja/stdx

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CleanIfNoneMatchHeader(requestEtag string) string
func DefaultClient() *http.Client
func ServeError(res http.ResponseWriter, message string, statusCode int)
func ServerErrorForbidden(res http.ResponseWriter)
func ServerErrorInternal(res http.ResponseWriter)
func ServerErrorNotFound(res http.ResponseWriter)
func WebappHandler(folder fs.FS, config *WebappHandlerConfig) (handler func(w http.ResponseWriter, r *http.Request), err error)
type CacheRule
type WebappHandlerConfig

Constants ¶

View Source

const (
	HeaderLastModified            = "Last-Modified"
	HeaderContentType             = "Content-Type"
	HeaderContentEncoding         = "Content-Encoding"
	HeaderCacheControl            = "Cache-Control"
	HeaderContentLength           = "Content-Length"
	HeaderConnection              = "Connection"
	HeaderETag                    = "ETag"
	HeaderServer                  = "Server"
	HeaderIfModifiedSince         = "If-Modified-Since"
	HeaderExpires                 = "Expires"
	HeaderIfNoneMatch             = "If-None-Match"
	HeaderAccept                  = "Accept"
	HeaderUserAgent               = "User-Agent"
	HeaderAuthorization           = "Authorization"
	HeaderAltSvc                  = "Alt-Svc"
	HeaderStrictTransportSecurity = "Strict-Transport-Security"
	HeaderContentDisposition      = "Content-Disposition"
	HeaderContentRange            = "Content-Range"
	HeaderReferer                 = "Referer"
	HeaderDoNotTrack              = "Dnt"
	HeaderRange                   = "Range"
	HeaderAcceptLanguage          = "Accept-Language"
	HeaderAcceptRanges            = "Accept-Ranges"
)

View Source

const (
	CacheControlNoCache = "private, no-cache, no-store, must-revalidate" // "no-cache, no-store, no-transform, must-revalidate, private, max-age=0"
	CacheControlDynamic = "public, no-cache, must-revalidate"            // TODO https://web.dev/http-cache/, https://web.dev/love-your-cache/
	// CacheControlDynamic    = "max-age=0, must-revalidate, public" // TODO https://web.dev/http-cache/, https://web.dev/love-your-cache/
	// CacheControlNoCache       = "no-cache, no-store, no-transform, must-revalidate" // "no-cache, no-store, no-transform, must-revalidate, private, max-age=0"
	CacheControl30Seconds = "public, max-age=30, must-revalidate"
	CacheControl1Minute   = "public, max-age=60, must-revalidate"
	CacheControl5Minutes  = "public, max-age=300, stale-while-revalidate=30"
	CacheControl10Minutes = "public, max-age=600, stale-while-revalidate=60"
	CacheControl15Minutes = "public, max-age=900, stale-while-revalidate=90"
	CacheControl30Minutes = "public, max-age=1800, stale-while-revalidate=180"
	CacheControl1Hour     = "public, max-age=3600, stale-while-revalidate=360"
	CacheControl1Day      = "public, max-age=86400, stale-while-revalidate=600"
	CacheControl1Week     = "public, max-age=604800, stale-while-revalidate=600"
	CacheControl1Month    = "public, max-age=2592000, stale-while-revalidate=600"
	CacheControlImmutable = "public, max-age=31536000, immutable"
)

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control https://developer.mozilla.org/en-US/docs/Web/HTTP/Caching

View Source

const (
	MediaTypeText = "text/plain"
	MediaTypeXml  = "application/xml"
	MediaTypeJson = "application/json"

	MediaTypeHtmlUtf8 = "text/html; charset=utf-8"
	MediaTypeTextUtf8 = "text/plain; charset=utf-8"

	MediaTypeJsonFeed = "application/feed+json"
	MediaTypeRSS      = "application/rss+xml"
	MediaTypeAtom     = "application/atom+xml"

	MediaTypeAudio = "audio"
	MediaTypeVideo = "video"
	MediaTypePNG   = "image/png"
	MediaTypeJPEG  = "image/jpeg"
	MediaTypeSVG   = "image/svg+xml"

	// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
	// alternative value from the 'file' command line program: text/x-shellscript
	MediaTypeShellScript = "application/x-sh"
)

View Source

const (
	AcceptRangesBytes = "bytes"
)

View Source

const (
	CacheControl30SecondsCdnOnly = "public, max-age=0, s-max-age=30, must-revalidate"
)

Variables ¶

View Source

var ErrDir = errors.New("path is a folder")

View Source

var ErrInternalError = errors.New("Internal Server Error")

View Source

var ErrInvalidPath = errors.New("path is not valid")

Functions ¶

func CleanIfNoneMatchHeader ¶

func CleanIfNoneMatchHeader(requestEtag string) string

CleanIfNoneMatchHeader removes the W/ and " from a If-None-Match header

func DefaultClient ¶

func DefaultClient() *http.Client

DefaultClient returns an HTTP client with sane defaults

func ServeError ¶

func ServeError(res http.ResponseWriter, message string, statusCode int)

func ServerErrorForbidden ¶

func ServerErrorForbidden(res http.ResponseWriter)

TODO: Do we force close the TCP connection? https://stackoverflow.com/questions/72368886/is-there-a-way-to-drop-an-http-connection-in-golang-without-sending-anything-to https://www.bentasker.co.uk/posts/blog/software-development/golang-net-http-net-http-2-does-not-reliably-close-failed-connections-allowing-attempted-reuse.html

func ServerErrorInternal ¶

func ServerErrorInternal(res http.ResponseWriter)

func ServerErrorNotFound ¶

func ServerErrorNotFound(res http.ResponseWriter)

func WebappHandler ¶

func WebappHandler(folder fs.FS, config *WebappHandlerConfig) (handler func(w http.ResponseWriter, r *http.Request), err error)

WebappHandler is an http.Handler that is designed to efficiently serve Single Page Applications. if a file is not found, it will return notFoundFile (default: index.html) with the stauscode statusNotFound WebappHandler sets the correct ETag header and cache the hash of files so that repeated requests to files return only StatusNotModified responses WebappHandler returns StatusMethodNotAllowed if the method is different than GET or HEAD

Types ¶

type CacheRule ¶

type CacheRule struct {
	Regexp string

	CacheControl string
	// contains filtered or unexported fields
}

type WebappHandlerConfig ¶

type WebappHandlerConfig struct {
	// default: index.html
	NotFoundFile string
	// default: 200
	NotFoundStatus int
	// default: public, no-cache, must-revalidate
	NotFoundCacheControl string
	// default: ".js", ".css", ".woff", ".woff2"
	Cache []CacheRule
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
autocertpg
cors Package cors is net/http handler to handle CORS related requests as defined by http://www.w3.org/TR/cors/	Package cors is net/http handler to handle CORS related requests as defined by http://www.w3.org/TR/cors/
hostrouter
middlewarex

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL