rest

package

v0.0.0-...-044f632 Latest Latest Go to latest Published: Jun 28, 2022 License: GPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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 interface {
	AuthenticateUser(ctx context.Context, r *http.Request) (User, error)
}

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

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

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

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

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

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

func AuthMiddleware(provider AuthProvider) Middleware

func CORSMiddleware(allowedOrigins []string) Middleware

func LoggingMiddleware(logger service.Logger) Middleware

func MetricsMiddleware(metric MetricCollector) Middleware

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

type Route struct {
	Pattern string
	Handler http.Handler
}

type User struct {
	UUID        string
	DisplayName string
}

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

Path	Synopsis
v1 Package v1 provides primitives to interact with the openapi HTTP API.	Package v1 provides primitives to interact with the openapi HTTP API.