restapi

package module

Go to main page

Versions in this module

v0

v0.3.0

Jul 4, 2024

Changes in this version

type Result

+ func (r *Result) Content() any

+ func (r *Result) ContentType() string

+ func (r *Result) Headers() headers

+ func (r *Result) StatusCode() int

v0.2.0

Jun 17, 2024

Changes in this version

+ var ErrUnexpectedField = errors.New("unexpected field")

type EndpointFunc

+ func (f EndpointFunc) ServeAPI(ctx context.Context, rq *http.Request) any

type EndpointHandler

+ ServeAPI func(context.Context, *http.Request) any

type Error

+ func (err Error) Is(target error) bool

type Result

+ func NotImplemented() *Result

v0.1.0

May 31, 2024

Changes in this version

+ var ErrBodyRequired = errors.New("a body is required")

+ var ErrErrorReadingRequestBody = errors.New("error reading request body")

+ var ErrInvalidAcceptHeader = errors.New("no formatter for content type")

+ var ErrInvalidArgument = errors.New("invalid argument")

+ var ErrInvalidOperation = errors.New("invalid operation")

+ var ErrInvalidStatusCode = errors.New("invalid statuscode")

+ var ErrMarshalErrorFailed = errors.New("error marshalling an Error response")

+ var ErrMarshalResultFailed = errors.New("error marshalling response")

+ var ErrNoAcceptHeader = errors.New("no Accept header")

+ var LogError = func(InternalError)

+ var ProjectError = func(err ErrorInfo) any

+ func HandleRequest[T any](rq *http.Request, h func(ctx context.Context, c *T) any) any

+ func Handler(h EndpointHandler) http.HandlerFunc

+ func HandlerFunc(h EndpointFunc) http.HandlerFunc

+ type EndpointFunc func(_ http.ResponseWriter, rq *http.Request) any

+ type EndpointHandler interface

+ ServeHTTP func(http.ResponseWriter, *http.Request) any

+ type Error struct

+ func BadRequest(args ...any) *Error

+ func Forbidden(args ...any) *Error

+ func InternalServerError(args ...any) *Error

+ func NewError(args ...any) *Error

+ func NotFound(args ...any) *Error

+ func Unauthorized(args ...any) *Error

+ func (apierr Error) Unwrap() error

+ func (err *Error) WithHeader(k string, v any) *Error

+ func (err *Error) WithHeaders(headers map[string]any) *Error

+ func (err *Error) WithHelp(s string) *Error

+ func (err *Error) WithMessage(s string) *Error

+ func (err *Error) WithNonCanonicalHeader(k string, v any) *Error

+ func (err *Error) WithProperty(key string, value any) *Error

+ func (err Error) Error() string

+ func (h Error) String() string

+ type ErrorInfo struct

+ Err error

+ Help string

+ Message string

+ Properties map[string]any

+ Request *http.Request

+ StatusCode int

+ TimeStamp time.Time

+ type InternalError struct

+ ContentType string

+ Err error

+ Help string

+ Message string

+ Request *http.Request

+ type Problem struct

+ Detail string

+ Instance *url.URL

+ Status int

+ Title string

+ Type *url.URL

+ func NewProblem(args ...any) *Problem

+ func (p *Problem) WithDetail(detail string) *Problem

+ func (p *Problem) WithInstance(instance url.URL) *Problem

+ func (p *Problem) WithProperty(key string, value any) *Problem

+ func (p *Problem) WithType(url url.URL, title ...string) *Problem

+ type Request struct

+ Accept string

+ MarshalContent func(any) ([]byte, error)

+ type Response struct

+ Content []byte

+ ContentType string

+ StatusCode int

+ func (h Response) String() string

+ type Result struct

+ func Accepted() *Result

+ func Created() *Result

+ func NoContent() *Result

+ func OK() *Result

+ func Status(statusCode int) *Result

+ func (r *Result) WithContent(contentType string, content []byte) *Result

+ func (r *Result) WithHeader(k string, v any) *Result

+ func (r *Result) WithHeaders(headers map[string]any) *Result

+ func (r *Result) WithNonCanonicalHeader(k string, v any) *Result

+ func (r *Result) WithValue(value any) *Result

+ func (r Result) String() string

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