api

Feb 9, 2021

Changes in this version

type RedirectError

+ Err string

Jan 13, 2021

Changes in this version

+ func RequesHost(ctx context.Context) string

Sep 30, 2020

Changes in this version

+ func Principal(ctx context.Context) interface

Sep 16, 2020

Changes in this version

type Parameters

+ BindRequest func(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) error

Sep 12, 2020

Changes in this version

+ func Write(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

+ func WriteJSON(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

+ func WriteXML(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

type Authorizer

+ func BasicAuthorizer(handler func(user string, pass string) ([]string, error)) Authorizer

+ type BasicContext interface

+ Permissions func() []string

+ Username func() string

type Option

+ func Addr(addr string) Option

+ func Basepath(base string) Option

+ func Listener(l net.Listener) Option

+ func Name(name string) Option

+ func Router(router *mux.Router) Option

+ func Versioning(version string, serverVersion ...string) Option

type Parameters

+ BindRequestW func(w http.ResponseWriter, r *http.Request, c ...runtime.Consumer) error

type Response

+ func (r *Response) WithWriter(w WriterFunc) *Response

+ type WriterFunc func(w http.ResponseWriter, status int, payload interface{}, headers ...http.Header) error

Dec 15, 2021

Changes in this version

+ func RequestURI(ctx context.Context) *url.URL

Dec 15, 2021

Changes in this version

type RouteOption

+ func WithDecoderRegister(f func(*schema.Decoder)) RouteOption

Jun 6, 2021

Changes in this version

+ func GetContextUser(ctx context.Context) string

+ func SetContextLog(ctx context.Context, log log.Interface) context.Context

+ func SetContextUser(ctx context.Context, u string) context.Context

Jun 4, 2021

Changes in this version

+ var ErrConflict = Error().WithStatus(http.StatusConflict)

+ var ErrNotImplemented = Error().WithStatus(http.StatusNotImplemented)

+ var ErrTimeout = Error().WithStatus(http.StatusRequestTimeout)

type ErrorResponse

+ func (e *ErrorResponse) WithMeta(k string, v interface{}) *ErrorResponse

May 13, 2021

Changes in this version

+ var ErrBadRequest = Error().WithStatus(http.StatusBadRequest)

+ var ErrForbidden = Error().WithStatus(http.StatusForbidden)

+ var ErrNotFound = Error().WithStatus(http.StatusNotFound)

+ var ErrServerError = Error().WithStatus(http.StatusInternalServerError)

+ var ErrUnauthorized = Error().WithStatus(http.StatusUnauthorized)

+ type ErrorResponder interface

+ Code func() string

+ type ErrorResponse struct

+ func (e *ErrorResponse) Is(target error) bool

+ func (e *ErrorResponse) Payload() interface{}

+ func (e *ErrorResponse) WithCode(code string) *ErrorResponse

+ func (e *ErrorResponse) WithError(err error) *ErrorResponse

+ func (e *ErrorResponse) WithHeader(key string, value string) *ErrorResponse

+ func (e *ErrorResponse) WithMessage(f string, args ...interface{}) *ErrorResponse

+ func (e *ErrorResponse) WithStatus(status int) *ErrorResponse

+ func (e *ErrorResponse) Write(w http.ResponseWriter, req *http.Request) error

+ func (e ErrorResponse) Code() string

+ func (e ErrorResponse) Error() string

+ func (e ErrorResponse) Redirect(u *url.URL) *Response

+ func (e ErrorResponse) Status() int

May 5, 2021

Changes in this version

type RouteOption

+ func WithDecoder(dec *schema.Decoder) RouteOption

May 4, 2021

Changes in this version

+ type APIError interface

+ ErrorCode func() string

+ StatusCode func() int

Feb 9, 2021

Changes in this version

+ func Log(ctx context.Context) log.Interface

+ func Request(ctx context.Context) (*http.Request, http.ResponseWriter)

+ func RequestBody(ctx context.Context) []byte

+ func RequestHost(ctx context.Context) string

+ type Authorizer func(r *http.Request) (context.Context, error)

+ type ContextFunc func(context.Context) context.Context

+ type EncodeFunc func(w io.Writer) error

+ type Encoder interface

+ Encode func(w io.Writer) error

+ type Option func(*Server)

+ func WithAddr(addr string) Option

+ func WithBasepath(base string) Option

+ func WithCORS(origin ...string) Option

+ func WithCache(ttl time.Duration) Option

+ func WithListener(l net.Listener) Option

+ func WithLog(l log.Interface) Option

+ func WithName(name string) Option

+ func WithRouter(router *mux.Router) Option

+ func WithVersioning(version string, serverVersion ...string) Option

+ type Parameters interface

+ Validate func() error

+ type RedirectError struct

+ ErrDescription string

+ Status int

+ URL *url.URL

+ type Responder interface

+ Payload func() interface{}

+ Status func() int

+ Write func(w http.ResponseWriter, r *http.Request) error

+ type Response struct

+ func Error(e error) *Response

+ func ErrorRedirect(u *url.URL, status int, f string, args ...interface{}) *Response

+ func Errorf(f string, args ...interface{}) *Response

+ func NewResponse(payload ...interface{}) *Response

+ func Redirect(u *url.URL, args ...map[string]string) *Response

+ func StatusError(status int, e error) *Response

+ func StatusErrorf(status int, f string, args ...interface{}) *Response

+ func (r *Response) Payload() interface{}

+ func (r *Response) Status() int

+ func (r *Response) WithHeader(key string, value string) *Response

+ func (r *Response) WithHeaders(h map[string]interface{}) *Response

+ func (r *Response) WithStatus(status int) *Response

+ func (r *Response) Write(w http.ResponseWriter, req *http.Request) error

+ type RouteOption func(*routeOption)

+ func WithAuthorizers(a ...Authorizer) RouteOption

+ func WithCaching() RouteOption

+ func WithContextFunc(f ContextFunc) RouteOption

+ func WithMethod(m string) RouteOption

+ func WithParams(p interface{}) RouteOption

+ func WithValidation(v bool) RouteOption

+ type Server struct

+ func NewServer(opts ...Option) *Server

+ func (s *Server) AddRoute(path string, handler interface{}, opts ...RouteOption)

+ func (s *Server) Handler() http.Handler

+ func (s *Server) Log() log.Interface

+ func (s *Server) LogMiddleware() func(http.Handler) http.Handler

+ func (s *Server) RequestVersion(r *http.Request) string

+ func (s *Server) Router() *mux.Router

+ func (s *Server) Serve() error

+ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (s *Server) Shutdown(ctx context.Context) error

+ func (s *Server) WriteError(w http.ResponseWriter, status int, err error)

+ func (s *Server) WriteJSON(w http.ResponseWriter, status int, v interface{}, pretty ...bool)