httpx

Documentation

Index

• Constants
• func Error(w http.ResponseWriter, err error, ...)
• func ErrorCtx(ctx context.Context, w http.ResponseWriter, err error, ...)
• func GetFormValues(r *http.Request) (map[string]any, error)
• func GetRemoteAddr(r *http.Request) string
• func Ok(w http.ResponseWriter)
• func OkJson(w http.ResponseWriter, v any)
• func OkJsonCtx(ctx context.Context, w http.ResponseWriter, v any)
• func Parse(r *http.Request, v any) error
• func ParseForm(r *http.Request, v any) error
• func ParseHeader(headerValue string) map[string]string
• func ParseHeaders(r *http.Request, v any) error
• func ParseJsonBody(r *http.Request, v any) error
• func ParsePath(r *http.Request, v any) error
• func SetErrorHandler(handler func(error) (int, any))
• func SetErrorHandlerCtx(handlerCtx func(context.Context, error) (int, any))
• func SetOkHandler(handler func(context.Context, any) any)
• func SetValidator(val Validator)
• func Stream(ctx context.Context, w http.ResponseWriter, fn func(w io.Writer) bool)
• func WriteJson(w http.ResponseWriter, code int, v any)
• func WriteJsonCtx(ctx context.Context, w http.ResponseWriter, code int, v any)
• type Router
• type Validator

Constants

const (
	// ContentEncoding means Content-Encoding.
	ContentEncoding = "Content-Encoding"
	// ContentSecurity means X-Content-Security.
	ContentSecurity = "X-Content-Security"
	// ContentType means Content-Type.
	ContentType = header.ContentType
	// JsonContentType means application/json.
	JsonContentType = header.JsonContentType
	// KeyField means key.
	KeyField = "key"
	// SecretField means secret.
	SecretField = "secret"
	// TypeField means type.
	TypeField = "type"
	// CryptionType means cryption.
	CryptionType = 1
)

const (
	// CodeSignaturePass means signature verification passed.
	CodeSignaturePass = iota
	// CodeSignatureInvalidHeader means invalid header in signature.
	CodeSignatureInvalidHeader
	// CodeSignatureWrongTime means wrong timestamp in signature.
	CodeSignatureWrongTime
	// CodeSignatureInvalidToken means invalid token in signature.
	CodeSignatureInvalidToken
)

Functions

func Error

func Error(w http.ResponseWriter, err error, fns ...func(w http.ResponseWriter, err error))

Error writes err into w.

func ErrorCtx

func ErrorCtx(ctx context.Context, w http.ResponseWriter, err error,
	fns ...func(w http.ResponseWriter, err error))

ErrorCtx writes err into w.

func GetFormValues

func GetFormValues(r *http.Request) (map[string]any, error)

GetFormValues returns the form values.

func GetRemoteAddr

func GetRemoteAddr(r *http.Request) string

GetRemoteAddr returns the peer address, supports X-Forward-For.

func Ok

func Ok(w http.ResponseWriter)

Ok writes HTTP 200 OK into w.

func OkJson

func OkJson(w http.ResponseWriter, v any)

OkJson writes v into w with 200 OK.

func OkJsonCtx

func OkJsonCtx(ctx context.Context, w http.ResponseWriter, v any)

OkJsonCtx writes v into w with 200 OK.

func Parse

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

Parse parses the request.

func ParseForm

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

ParseForm parses the form request.

func ParseHeader

func ParseHeader(headerValue string) map[string]string

ParseHeader parses the request header and returns a map.

func ParseHeaders

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

ParseHeaders parses the headers request.

func ParseJsonBody

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

ParseJsonBody parses the post request which contains json in body.

func ParsePath

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

ParsePath parses the symbols reside in url path. Like http://localhost/bag/:name

func SetErrorHandler

func SetErrorHandler(handler func(error) (int, any))

SetErrorHandler sets the error handler, which is called on calling Error. Notice: SetErrorHandler and SetErrorHandlerCtx set the same error handler. Keeping both SetErrorHandler and SetErrorHandlerCtx is for backward compatibility.

func SetErrorHandlerCtx

func SetErrorHandlerCtx(handlerCtx func(context.Context, error) (int, any))

SetErrorHandlerCtx sets the error handler, which is called on calling Error. Notice: SetErrorHandler and SetErrorHandlerCtx set the same error handler. Keeping both SetErrorHandler and SetErrorHandlerCtx is for backward compatibility.

func SetOkHandler

func SetOkHandler(handler func(context.Context, any) any)

SetOkHandler sets the response handler, which is called on calling OkJson and OkJsonCtx.

func SetValidator

func SetValidator(val Validator)

SetValidator sets the validator. The validator is used to validate the request, only called in Parse, not in ParseHeaders, ParseForm, ParseHeader, ParseJsonBody, ParsePath.

func Stream

func Stream(ctx context.Context, w http.ResponseWriter, fn func(w io.Writer) bool)

Stream writes data into w with streaming mode. The ctx is used to control the streaming loop, typically use r.Context(). The fn is called repeatedly until it returns false.

func WriteJson

func WriteJson(w http.ResponseWriter, code int, v any)

WriteJson writes v as json string into w with code.

func WriteJsonCtx

func WriteJsonCtx(ctx context.Context, w http.ResponseWriter, code int, v any)

WriteJsonCtx writes v as json string into w with code.

Types

type Router

type Router interface {
	http.Handler
	Handle(method, path string, handler http.Handler) error
	SetNotFoundHandler(handler http.Handler)
	SetNotAllowedHandler(handler http.Handler)
}

Router interface represents a http router that handles http requests.

type Validator

type Validator interface {
	// Validate validates the request and parsed data.
	Validate(r *http.Request, data any) error
}

Validator defines the interface for validating the request.