httpx

README

httpx

Better net/http for Go.

Rationale

TODO

Features

• Simple.

See GUIDE.md for more details.

Install

Go version 1.17+

go get github.com/cristalhq/httpx

Example

TODO

Documentation

See these docs.

License

MIT License.

Documentation

Index

• Variables
• func Bearer(token string) string
• func DiscardResponseBody(resp *http.Response)
• func DumpRequest(r *http.Request) string
• func ErrorResponse(w http.ResponseWriter, code int, err error)
• func Is1xx(code int) bool
• func Is2xx(code int) bool
• func Is3xx(code int) bool
• func Is4xx(code int) bool
• func Is5xx(code int) bool
• func MarshalResponse(w http.ResponseWriter, status int, response interface{})
• func MustGetRequest(ctx context.Context, url string) *http.Request
• func MustNewRequest(ctx context.Context, method, url string, body io.Reader) *http.Request
• func MustPostRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func MustPutRequest(ctx context.Context, url string, body io.Reader) *http.Request
• func NewClient() *http.Client
• func NewConnectRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewDeleteRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewGetRequest(ctx context.Context, url string) (*http.Request, error)
• func NewHeadRequest(ctx context.Context, url string) (*http.Request, error)
• func NewOptionsRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPatchRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPostRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewPutRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)
• func NewTraceRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)
• func NoopHandler(http.ResponseWriter, *http.Request)
• func ReturnBadRequest(w http.ResponseWriter, err error)
• func ReturnNotFound(w http.ResponseWriter)
• func ReturnOK(w http.ResponseWriter)
• func ReturnOKJSON(w http.ResponseWriter, data interface{})
• func ReturnRedirect(w http.ResponseWriter)
• func UnmarshalRequest(w http.ResponseWriter, r *http.Request, data interface{}) (code int, err error)
• type Doer
• type Error
  • func (e Error) Error() string
• type Server
  • func NewServer(config *ServerConfig) (*Server, error)
  • func (s *Server) Run(ctx context.Context) error
  • func (s *Server) Start(ctx context.Context, h http.Handler) error
• type ServerConfig
  • func (c *ServerConfig) Validate() error

Variables

var NoBody = http.NoBody

Functions

func Bearer

func Bearer(token string) string

Bearer header with a give token.

func DiscardResponseBody

func DiscardResponseBody(resp *http.Response)

DiscardResponseBody reads and closes http.Response.Body.

func DumpRequest

func DumpRequest(r *http.Request) string

func ErrorResponse

func ErrorResponse(w http.ResponseWriter, code int, err error)

ErrorResponse return and error wrapped into JSON. If the err is httpx.Error, code parameter is ignoted and httpx.Error.Code is used. If the err is nil just status code is returned.

func Is1xx

func Is1xx(code int) bool

func Is2xx

func Is2xx(code int) bool

func Is3xx

func Is3xx(code int) bool

func Is4xx

func Is4xx(code int) bool

func Is5xx

func Is5xx(code int) bool

func MarshalResponse

func MarshalResponse(w http.ResponseWriter, status int, response interface{})

MarshalResponse writes an object to the http.ResponseWriter or a fallback error.

func MustGetRequest

func MustGetRequest(ctx context.Context, url string) *http.Request

MustGetRequest returns a new http.Request with GET method or panics on error.

func MustNewRequest

func MustNewRequest(ctx context.Context, method, url string, body io.Reader) *http.Request

MustNewRequest returns a new http.Request or panics on error.

func MustPostRequest

func MustPostRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustPostRequest returns a new http.Request with POST method or panics on error.

func MustPutRequest

func MustPutRequest(ctx context.Context, url string, body io.Reader) *http.Request

MustPutRequest returns a new http.Request with PUT method or panics on error.

func NewClient

func NewClient() *http.Client

NewClient return http.Client with a sane default.

func NewConnectRequest

func NewConnectRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewConnectRequest returns a new http.Request with CONNECT method.

func NewDeleteRequest

func NewDeleteRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewDeleteRequest returns a new http.Request with DELETE method.

func NewGetRequest

func NewGetRequest(ctx context.Context, url string) (*http.Request, error)

NewGetRequest returns a new http.Request with GET method.

func NewHeadRequest

func NewHeadRequest(ctx context.Context, url string) (*http.Request, error)

NewHeadRequest returns a new http.Request with HEAD method.

func NewOptionsRequest

func NewOptionsRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewOptionsRequest returns a new http.Request with OPTIONS method.

func NewPatchRequest

func NewPatchRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPatchRequest returns a new http.Request with PATCH method.

func NewPostRequest

func NewPostRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPostRequest returns a new http.Request with POST method.

func NewPutRequest

func NewPutRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewPutRequest returns a new http.Request with PUT method.

func NewRequest

func NewRequest(ctx context.Context, method, url string, body io.Reader) (*http.Request, error)

NewRequest returns a new http.Request.

func NewTraceRequest

func NewTraceRequest(ctx context.Context, url string, body io.Reader) (*http.Request, error)

NewTraceRequest returns a new http.Request with TRACE method.

func NoopHandler

func NoopHandler(http.ResponseWriter, *http.Request)

NoopHandler just return 200 OK. Useful for prototyping.

func ReturnBadRequest

func ReturnBadRequest(w http.ResponseWriter, err error)

func ReturnNotFound

func ReturnNotFound(w http.ResponseWriter)

func ReturnOK

func ReturnOK(w http.ResponseWriter)

func ReturnOKJSON

func ReturnOKJSON(w http.ResponseWriter, data interface{})

func ReturnRedirect

func ReturnRedirect(w http.ResponseWriter)

func UnmarshalRequest

func UnmarshalRequest(w http.ResponseWriter, r *http.Request, data interface{}) (code int, err error)

UnmarshalRequest as JSON with well defined error handling.

Types

type Doer

type Doer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer is an interface for http.Client.

type Error

type Error struct {
	Code    int    `json:"code,omitempty"`
	Type    string `json:"type,omitempty"`
	Message string `json:"msg,omitempty"`
}

Error for a request.

func (Error) Error

func (e Error) Error() string

type Server

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

Server for HTTP protocol.

func NewServer

func NewServer(config *ServerConfig) (*Server, error)

NewServer returns a new Server.

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Run starts the server.

func (*Server) Start

func (s *Server) Start(ctx context.Context, h http.Handler) error

Start the server with a given handler. Same as Run but allows to set handler later.

type ServerConfig

type ServerConfig struct {
	Addr    string
	Handler http.Handler

	NoHTTP2   bool
	TLSConfig *tls.Config

	// TODO: enable option
	HeartbeatPath    string
	HeartbeatHandler http.HandlerFunc

	ReadTimeout       time.Duration
	ReadHeaderTimeout time.Duration
	WriteTimeout      time.Duration
	IdleTimeout       time.Duration
	MaxHeaderBytes    int
}

ServerConfig configures Server.

func (*ServerConfig) Validate

func (c *ServerConfig) Validate() error

Validate the config.