api

package

v0.38.0 Latest Latest Go to latest Published: Jul 11, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/coldsmirk/vef-framework-go

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewEngine(opts ...EngineOption) (api.Engine, error)
type EngineOption
type EngineParams

Constants ¶

This section is empty.

Variables ¶

View Source

var Module = fx.Module(
	"vef:api",
	auth.Module,
	middleware.Module,
	router.Module,
	collector.Module,
	resolver.Module,
	adapter.Module,
	param.Module,
	fx.Provide(provideEngine),
)

Functions ¶

func NewEngine ¶

func NewEngine(opts ...EngineOption) (api.Engine, error)

NewEngine creates a new API engine with the given options.

Types ¶

type EngineOption ¶

type EngineOption func(*engine)

func WithDefaultRateLimit ¶

func WithDefaultRateLimit(limit *api.RateLimitConfig) EngineOption

WithDefaultRateLimit overrides the built-in default rate limit applied to operations that declare none of their own (wired from vef.api.rate_limit). A nil limit is ignored so the built-in default survives.

func WithHandlerAdapters ¶

func WithHandlerAdapters(adapters ...api.HandlerAdapter) EngineOption

func WithHandlerResolvers ¶

func WithHandlerResolvers(resolvers ...api.HandlerResolver) EngineOption

func WithOperationCollectors ¶

func WithOperationCollectors(collectors ...api.OperationsCollector) EngineOption

func WithRouters ¶

func WithRouters(routers ...api.RouterStrategy) EngineOption

type EngineParams ¶

type EngineParams struct {
	fx.In

	APIConfig *config.APIConfig

	Resources        []api.Resource       `group:"vef:api:resources"`
	RouterStrategies []api.RouterStrategy `group:"vef:api:router_strategies"`

	OperationsCollectors []api.OperationsCollector `group:"vef:api:operations_collectors"`
	HandlerResolvers     []api.HandlerResolver     `group:"vef:api:handler_resolvers"`
	HandlerAdapters      []api.HandlerAdapter      `group:"vef:api:handler_adapters"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
adapter
auth
collector
handler
middleware
param
resolver
router
shared

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL