api

Documentation

Index

• func ServeError(log *zap.Logger, w http.ResponseWriter, status int, err error)
• type Auth
• type CORS
• type HTTPError
  • func (e HTTPError) Error() string

Functions

func ServeError

func ServeError(log *zap.Logger, w http.ResponseWriter, status int, err error)

ServeError writes JSON error to response output stream.

Types

type Auth

type Auth interface {
	// IsAuthenticated checks if request is performed with all needed authorization credentials.
	IsAuthenticated(ctx context.Context, r *http.Request, isCookieAuth, isKeyAuth bool) (context.Context, error)
	// RemoveAuthCookie indicates to the client that the authentication cookie should be removed.
	RemoveAuthCookie(w http.ResponseWriter)
}

Auth exposes methods to control authentication process for each endpoint.

type CORS

type CORS interface {
	// Handle sets the necessary CORS headers for the request and checks if the request is an OPTIONS preflight request.
	Handle(w http.ResponseWriter, r *http.Request) bool
}

CORS exposes methods to control CORS (Cross-Origin Resource Sharing) for each endpoint.

type HTTPError

type HTTPError struct {
	Status int
	Err    error
}

HTTPError holds http error entity with http status and error itself.

func (HTTPError) Error

func (e HTTPError) Error() string

Error returns http error's string representation.