How fristi/itinere works
Main Components
a. Core Module (Primary)
• Represents the fundamental abstractions (HttpEndpointAlgebra, JsonAlgebra, etc.)
• Contains the main DSL definitions
b. Integration Modules (Secondary)
• Http4s Server Implementation
• Circe JSON Integration
• OpenAPI Generation
• Refined Type Integration
Component Relationships
┌─────────────────────────────────────────────────────┐
• Client Applications │
• ┬─────────────────────────┘
• ↓
┌─────────────────────────────────────────────────────┐
• Http4s Server Layer │
• (http4s-server module - HTTP server implementation)│
• ┬─────────────────────────┘
• ↓
┌─────────────────────────────────────────────────────┐
• Core Module │
• HTTP Endpoint Algebra │
• JSON Algebra │
• Type Definitions │
• ┬─────────────────┬──────────────┬─────────┘
• ↓ ↓ ↓
┌─────────────────┐ ┌─────────────┐ ┌──────────────┐
• Circe Module │ │ OpenAPI Gen │ │ Refined │
• (JSON Codec) │ │ (Docs Gen) │ │ Types │
• ┘ └─────────────┘ └──────────────┘
Specific Elements
a. Core Components:
• HttpEndpointAlgebra (central component)
• JsonAlgebra (core JSON abstraction)
• Type System (Primitives, Types)
• Attempt (error handling)
b. Integration Points:
• Http4s Server Integration
• Circe JSON Integration
• OpenAPI Documentation Generation
• Refined Type System Integration
Implementation Details Level
Show:
• Major interfaces and type classes
• Primary data transformation flows
• Integration boundaries
• Extension points
The transformation pipeline from DSL to concrete implementations
Keep the focus on the architectural boundaries between modules while showing how the DSL flows through the system from definition to concrete implementation in HTTP services.
This approach will give a clear picture of how the EDSL is structured and how it can be extended or integrated with other systems.