api

package

v0.18.1 Latest Latest Go to latest Published: Jan 27, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Details

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

Repository

github.com/ilxqx/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 (
	ErrNoHandlerAdapter = errors.New("no handler adapter found")
)

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 ¶ added in v0.18.0

type EngineOption func(*engine)

func WithDefaultAuth ¶ added in v0.18.0

func WithDefaultAuth(auth *api.AuthConfig) EngineOption

func WithDefaultRateLimit ¶ added in v0.18.0

func WithDefaultRateLimit(rateLimit *api.RateLimitConfig) EngineOption

func WithDefaultTimeout ¶ added in v0.18.0

func WithDefaultTimeout(timeout time.Duration) EngineOption

func WithDefaultVersion ¶ added in v0.18.0

func WithDefaultVersion(version string) EngineOption

func WithHandlerAdapters ¶ added in v0.18.0

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

func WithHandlerResolvers ¶ added in v0.18.0

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

func WithOperationCollectors ¶ added in v0.18.0

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

func WithRouters ¶ added in v0.18.0

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

type EngineParams ¶ added in v0.18.0

type EngineParams struct {
	fx.In

	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