Skip to main content
Version: v0.16

Router

info

This module handles application-level APIs. For administration APIs, see Admin API Reference.

The Router module provides API routing for your application.

Features

  • REST API - Express-based HTTP endpoints
  • GraphQL API - Auto-generated GraphQL schema
  • WebSockets - Real-time communication via Socket.io
  • Auto Documentation - Swagger/OpenAPI for REST, introspection for GraphQL
  • Validation - Automatic parameter validation
  • Middleware - Custom middleware support

Minimum Configuration

No configuration required.

Environment Variables

NameRequiredDescriptionExample
CONDUIT_SERVERYesConduit Core address0.0.0.0:55152
CLIENT_HTTP_PORTNoREST/GraphQL port3000
CLIENT_SOCKET_PORTNoWebSocket port3001
SERVICE_URLNoService address0.0.0.0:56154
GRPC_PORTNogRPC server port56154
GRPC_KEYNogRPC signed request protectionsomeSecret

API Transports

TransportPortEndpoint
REST3000http://localhost:3000/
GraphQL3000http://localhost:3000/graphql
WebSocket3001ws://localhost:3001/
Swagger3000http://localhost:3000/swagger

Route Registration

Modules automatically register their routes. For custom routes, build a custom module.

Next Steps