apiframework

Documentation

Index

• type AppDesc
• type ServiceDesc

Types

type AppDesc

type AppDesc struct {
	// GlobalMiddleware is the list of application-global middleware.
	GlobalMiddleware []*middleware.Middleware

	// AuthHandler defines the application's auth handler, if any.
	AuthHandler option.Option[*authhandler.AuthHandler]
}

AppDesc describes an Encore Framework-based application.

type ServiceDesc

type ServiceDesc struct {
	// Middleware are the service-specific middleware
	Middleware []*middleware.Middleware

	// RootPkg is the root package of the service.
	RootPkg *pkginfo.Package

	// Endpoints are the endpoints defined in this service.
	Endpoints []*api.Endpoint

	// ServiceStruct defines the service's service struct, if any.
	ServiceStruct option.Option[*servicestruct.ServiceStruct]
}

ServiceDesc describes an Encore Framework-based service.

For code that deals with general services, use *service.Service instead of this type.