Interface documentation
Find your contract.
Choose the capability your module needs. Each reference explains the API you consume; the module catalogue helps you find its implementation.
Start with a task
Serve and protect requests
HTTP routes, authentication, validation and data endpoints.
Store and query data
Shared queries, models, schema inspection and database-specific access.
Connect external services
Email delivery, stored files, caching, scheduled work and Stripe.
Understand the runtime
Interface functions, proxies, lifecycle, metadata and logging.
A contract is not a provider
Install the interface to use its API. Configure a compatible provider to supply its implementation.
ConsumerYour business module
imports InterfaceThe shared contract
implements ProviderThe implementation
The application selects the provider module.
Both modules depend on the contract.
Your consumer imports the interface package. The provider implements that same contract. The consumer does not import the provider.