api

package

Go to main page

Versions in this module

v0

v0.1.5

Feb 13, 2022

v0.1.4

Nov 11, 2021

v0.1.3

Nov 11, 2021

v0.1.2

Aug 18, 2021

Changes in this version

+ var ErrTimeout = Errorf("timeout").WithStatus(http.StatusRequestTimeout)

type ErrorResponse

+ Code func() string

+ WithCode func(code string) ErrorResponse

+ type Redirector struct

+ func (r *Redirector) WithError(err error) *Redirector

+ func (r *Redirector) WithQuery(vals *url.Values) *Redirector

type Responder

+ func RedirectErrIf(cond bool, u *url.URL, err error) Responder

+ func RedirectIf(cond bool, u *url.URL, val ...interface{}) Responder

type StatusError

+ func (e StatusError) Code() string

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

v0.1.1

Mar 15, 2021

Changes in this version

+ var ErrNotImplemented = Errorf("operation is not implemented").WithStatus(http.StatusNotImplemented)

+ func RequestHost(ctx context.Context) string

v0.1.0

Dec 28, 2020

Changes in this version

+ const CredentialTypeAPIKey

+ const CredentialTypeBasic

+ const CredentialTypeBearer

+ const PrincipalTypeApplication

+ const PrincipalTypeUser

+ var ErrAuthUnacceptable = Errorf("no acceptable authorization data found").WithStatus(http.StatusUnauthorized)

+ var ErrBadRequest = Errorf("bad request").WithStatus(http.StatusBadRequest)

+ var ErrConflict = Errorf("conflict").WithStatus(http.StatusConflict)

+ var ErrForbidden = Errorf("forbidden").WithStatus(http.StatusForbidden)

+ var ErrNotFound = Errorf("not found").WithStatus(http.StatusNotFound)

+ var ErrServerError = Errorf("server error").WithStatus(http.StatusInternalServerError)

+ var ErrUnauthorized = Errorf("access denied").WithStatus(http.StatusUnauthorized)

+ func AuthPrincipal(ctx context.Context, target interface{}) bool

+ func Context(ctx context.Context) interface

+ func IsRequest(ctx context.Context) bool

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

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

+ func RequestVersion(r *http.Request) string

+ func RequirePrincipal(ctx context.Context, target interface{}, t ...PrincipalType)

+ func SessionManager(ctx context.Context) *session.Manager

+ func Unauthorized(r *http.Request) (interface{}, error)

+ func Version(ctx context.Context) string

+ func VersionMiddleware(v Versioner, header ...string) func(http.Handler) http.Handler

+ 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 AuthorizedRoute interface

+ RequireAuth func() []CredentialType

+ type Authorizer interface

+ Authorize func(r *http.Request, rt Route) (Principal, error)

+ CredentialType func() CredentialType

+ type AuthorizerFunc func(r *http.Request, rt Route) (Principal, error)

+ type CachedRoute interface

+ Timeout func() time.Duration

+ type Claims interface

+ All func() map[string]interface{}

+ Get func(key string) interface{}

+ Set func(key string, value interface{})

+ type CredentialType string

+ type Encoder interface

+ Encode func(w io.Writer) error

+ type ErrorResponse interface

+ Detail func() []string

+ WithDetail func(detail ...interface{}) ErrorResponse

+ WithError func(err error) ErrorResponse

+ WithMessage func(format string, args ...interface{}) ErrorResponse

+ WithStatus func(status int) ErrorResponse

+ func Error(err error) ErrorResponse

+ func Errorf(format string, args ...interface{}) ErrorResponse

+ type HandlerFunc func(http.ResponseWriter, *http.Request) Responder

+ 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 WithRouter(router *mux.Router) Option

+ func WithServerName(name string) Option

+ func WithTracing(t bool) Option

+ func WithVersion(v string) Option

+ type Principal interface

+ AuthClaims func() Claims

+ CredentialType func() CredentialType

+ Credentials func() string

+ Type func() PrincipalType

+ type PrincipalType string

+ type Responder interface

+ Payload func() interface{}

+ Status func() int

+ Write func(w http.ResponseWriter) error

+ type Response struct

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

+ func Redirect(u *url.URL, 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) WithStatus(status int) *Response

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

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

+ type Route interface

+ Methods func() []string

+ Name func() string

+ Path func() string

+ type RouteHook func(r *http.Request, rt Route) error

+ type Router struct

+ Mux *mux.Router

+ func (r *Router) AddRoutes(routes ...Route) *Router

+ func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Router) WithName(name string) RouterOption

+ func (r Router) Name() string

+ func (r Router) RequireVersion() bool

+ func (r Router) Version() string

+ type RouterOption func(r *Router)

+ func WithAuthorizers(auth ...Authorizer) RouterOption

+ func WithContext(ctx interface{}) RouterOption

+ func WithHooks(hooks ...RouteHook) RouterOption

+ func WithSessionManager(store *session.Manager) RouterOption

+ func WithVersioning(version ...string) RouterOption

+ type Server struct

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

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

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

+ func (s *Server) Name() string

+ func (s *Server) RequireVersion() bool

+ func (s *Server) Router(basePath string, opts ...RouterOption) *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) Version() string

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

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

+ type StatusError struct

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

+ func (e StatusError) Detail() []string

+ func (e StatusError) Error() string

+ func (e StatusError) Payload() interface{}

+ func (e StatusError) Status() int

+ func (e StatusError) WithDetail(detail ...interface{}) ErrorResponse

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

+ func (e StatusError) WithMessage(format string, args ...interface{}) ErrorResponse

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

+ func (e StatusError) Write(w http.ResponseWriter) error

+ type Versioner interface

+ Name func() string

+ RequireVersion func() bool

+ Version func() string

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

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