README.md

sidebar_position	sidebar_label
5	Reference

Reference Documentation

Technical reference documentation for Morphir backends, APIs, and tools.

📋 Contents

Backends

Platform-specific code generation backends:

Scala & Spark

• Scala Backend
• Scala API Usage
• Scala JSON Codecs Backend
• Morphir Scala Code Generation
• Spark Backend Design
• Spark Backend API
• Spark Backend Joins
• Spark Backend Optional Values
• Spark as Relational Backend
• Spark Testing Framework

Other Platforms

• Relational Backend
• TypeScript
• TypeScript API
• CADL/TypeSpec
• Spring Boot

JSON Schema

JSON Schema generation and configuration:

• JSON Codecs Documentation
• Generating JSON Schema
• JSON Schema Configuration
• JSON Schema Mappings
• JSON Schema Sample
• JSON Schema Developers Guide
• Codec Documentation

CLI Reference

Command-line interface documentation:

• CLI Incremental Build
• CLI Merging Documentation

Other Reference Materials

• Testing Framework
• Insight
• User Guide
• Versioning
• Error: Append Not Supported
• Table Template

🎯 How to Use This Section

This reference section is organized by technology and purpose:

• Looking for a specific backend? Check the backends/ folder
• Working with JSON? See json-schema/
• CLI questions? Browse cli/

🔍 Quick Reference

Common Tasks

• Generate Scala code: See Scala Backend
• Generate TypeScript: See TypeScript
• Work with JSON Schema: See Generating JSON Schema
• Understanding CLI: See CLI Reference

Backend Comparison

Different backends serve different purposes:

• Scala/Spark: For JVM-based execution and big data processing
• TypeScript: For web applications and Node.js
• JSON Schema: For API documentation and validation
• Spring Boot: For enterprise Java applications
• Relational: For database query generation

📚 Related Documentation

• Learn the concepts in Core Concepts
• See practical usage in User Guides
• Contribute backend improvements via Developer Guides

---

← Back to Documentation Home