api

Documentation

Index

• Variables
• type Authenticator
  • func NewAuthenticator(users *user.UserService) *Authenticator
  • func (a *Authenticator) AuthenticationFunc() openapi3filter.AuthenticationFunc
• type OpenAPIHandlerServices
• type Server
  • func NewServer(lx fx.Lifecycle, inputs ServerInputs, config e2clickermodule.API, ...) (*Server, error)
• type ServerInputs

Variables

var ErrNoAcceptableContentType = errors.New("no acceptable content type")

ErrNoAcceptableContentType is returned when the request does not have an acceptable Content-Type OR Accept header.

var ErrNotBearerAuth = errors.New("not a bearer authentication token")

var Module = fx.Module("api",
	fx.Decorate(func(slog *slog.Logger) *slog.Logger {
		return slog.With("module", "api")
	}),
	fx.Provide(
		NewServer,
		NewAuthenticator,
		newOpenAPIHandler,
		newOpenAPIHandlerForImportExport,

		(*Authenticator).AuthenticationFunc,

		(*openAPIHandlerForImportExport).asHandler,
	),
)

Types

type Authenticator

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

Authenticator is an authenticator that authenticates requests.

func NewAuthenticator

func NewAuthenticator(users *user.UserService) *Authenticator

NewAuthenticator creates a new authenticator.

func (*Authenticator) AuthenticationFunc

func (a *Authenticator) AuthenticationFunc() openapi3filter.AuthenticationFunc

type OpenAPIHandlerServices

type OpenAPIHandlerServices struct {
	fx.In

	Users             *user.UserService
	Notification      notification.NotificationService
	UserNotifications notification.UserNotificationService
	Dosage            dosage.DosageStorage
	DoseHistory       dosage.DoseHistoryStorage
}

OpenAPIHandlerServices is the set of service dependencies required by the OpenAPIHandler.

type Server

type Server struct {
}

Server provides an HTTP server that serves a [Handler].

func NewServer

func NewServer(
	lx fx.Lifecycle,
	inputs ServerInputs,
	config e2clickermodule.API,
	logger *slog.Logger,
) (*Server, error)

NewServer creates a new HTTP server.

type ServerInputs

type ServerInputs struct {
	fx.In

	Handler       openapi.ServerInterface
	Authenticator openapi3filter.AuthenticationFunc
}

ServerInputs is a set of dependencies required by the Server.