rest

Documentation

Index

• func BadRequest(slug string, err error, w http.ResponseWriter, r *http.Request)
• func Conflict(slug string, err error, w http.ResponseWriter, r *http.Request)
• func Forbidden(slug string, err error, w http.ResponseWriter, r *http.Request)
• func InternalServerError(slug string, err error, w http.ResponseWriter, r *http.Request)
• func NewHandler(params Params) http.Handler
• func NotFound(slug string, err error, w http.ResponseWriter, r *http.Request)
• func Unauthorized(slug string, err error, w http.ResponseWriter, r *http.Request)
• func UnprocessableEntity(slug string, err error, w http.ResponseWriter, r *http.Request)
• type AuthProvider
• type ErrorResponse
  • func (e ErrorResponse) Render(w http.ResponseWriter, _ *http.Request) error
• type Formatter
  • func (l *Formatter) NewLogEntry(r *http.Request) middleware.LogEntry
• type MetricCollector
• type Middleware
  • func AuthMiddleware(provider AuthProvider) Middleware
  • func CORSMiddleware(allowedOrigins []string) Middleware
  • func LoggingMiddleware(logger service.Logger) Middleware
  • func MetricsMiddleware(metric MetricCollector) Middleware
• type Params
• type Route
• type User
  • func UserFromCtx(ctx context.Context) (User, error)

Functions

func BadRequest

func BadRequest(slug string, err error, w http.ResponseWriter, r *http.Request)

func Conflict

func Conflict(slug string, err error, w http.ResponseWriter, r *http.Request)

func Forbidden

func Forbidden(slug string, err error, w http.ResponseWriter, r *http.Request)

func InternalServerError

func InternalServerError(slug string, err error, w http.ResponseWriter, r *http.Request)

func NewHandler

func NewHandler(params Params) http.Handler

func NotFound

func NotFound(slug string, err error, w http.ResponseWriter, r *http.Request)

func Unauthorized

func Unauthorized(slug string, err error, w http.ResponseWriter, r *http.Request)

func UnprocessableEntity

func UnprocessableEntity(slug string, err error, w http.ResponseWriter, r *http.Request)

Types

type AuthProvider

type AuthProvider interface {
	AuthenticateUser(ctx context.Context, r *http.Request) (User, error)
}

type ErrorResponse

type ErrorResponse struct {
	Slug    string `json:"slug"`
	Details string `json:"details"`
	// contains filtered or unexported fields
}

func (ErrorResponse) Render

func (e ErrorResponse) Render(w http.ResponseWriter, _ *http.Request) error

type Formatter

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

func (*Formatter) NewLogEntry

func (l *Formatter) NewLogEntry(r *http.Request) middleware.LogEntry

type MetricCollector

type MetricCollector interface {
	IncRequestsCount(status, method, path string)
}

type Middleware

type Middleware func(next http.Handler) http.Handler

func AuthMiddleware

func AuthMiddleware(provider AuthProvider) Middleware

func CORSMiddleware

func CORSMiddleware(allowedOrigins []string) Middleware

func LoggingMiddleware

func LoggingMiddleware(logger service.Logger) Middleware

func MetricsMiddleware

func MetricsMiddleware(metric MetricCollector) Middleware

type Params

type Params struct {
	Middlewares []Middleware
	Routes      []Route
}

type Route

type Route struct {
	Pattern string
	Handler http.Handler
}

type User

type User struct {
	UUID        string
	DisplayName string
}

func UserFromCtx

func UserFromCtx(ctx context.Context) (User, error)