Guide

Defjs separates the API a team publishes from the client an application uses. Follow the SDK authoring path to define and package operations; follow the application path to configure execution and handle results.

SDK developmentCopy Anchor Link

• Project overview
• Quick start
• Build and publish an SDK
• Why definitions and execution are separate

Contracts and executionCopy Anchor Link

SDK authors own Structs and endpoint definitions. Applications supply the Client and call operations with it.

• Data contracts / Struct
• Client configuration / Client

Requests and realtimeCopy Anchor Link

• HTTP requests
• SSE event streams
• WebSocket sessions

Errors and interceptionCopy Anchor Link

• Error handling
• Interceptors

PluginsCopy Anchor Link

Optional packages for the consuming application's client. SDK definitions stay independent of them.

• Plugins
• React
• Vue
• OpenTelemetry server

AICopy Anchor Link

• AI-assisted development
• Calling AI APIs

Design decisions