Fabrica Documentation

Complete documentation for the Fabrica framework - build resource-based REST APIs with automatic code generation.

📚 Quick Links

• Quick Start - Get started in 30 minutes
• Getting Started Guide - Full tutorial
• Architecture Overview - Framework design
• API Reference - Go package docs
• Blog - Short, friendly posts with examples

📖 Documentation Structure

Guides (guides/)

Step-by-step tutorials and how-tos for building with Fabrica:

Getting Started:

• Quick Start - 30-minute simple REST API
• Getting Started - Complete resource management tutorial

Core Features:

• Resource Model - Understanding Fabrica resources
• Storage Systems - File and database backends
• Ent Storage Integration - Using Ent ORM with databases
• Validation - Request validation and error handling

Advanced Features:

• Events - CloudEvents integration and event-driven patterns
• Reconciliation - Controller pattern for declarative management
• Versioning - Multi-version API support
• Spec Version History - Opt-in per-resource spec snapshots and history
• Conditional Requests - ETags and PATCH operations

Reference (reference/)

Technical reference and in-depth explanations:

• Architecture - Framework design and principles
• Code Generation - How templates work and customization
• Framework Comparison - Fabrica vs other Go frameworks
• Releasing - Release process and versioning
• Status Subresources - Kubernetes-style status management

🎯 Learning Paths

Path 1: Beginners (30 minutes)

1. Quick Start - Simple REST API
2. Resource Model - Understand resources

Path 2: Building Applications (2-4 hours)

1. Getting Started - Full tutorial
2. Storage Systems - Choose your backend
3. Validation - Add validation
4. Events - Event-driven patterns

Path 3: Advanced (1-2 days)

1. Architecture - Deep dive into design
2. Reconciliation - Declarative management
3. Versioning - Multi-version APIs
4. Code Generation - Customize templates

🔍 Common Tasks

I want to…

• Build a simple API quickly → Quick Start
• Learn the full framework → Getting Started
• Understand resources → Resource Model
• Choose a storage backend → Storage Systems
• Use a database → Ent Storage
• Add validation → Validation
• Build event-driven systems → Events
• Implement reconciliation → Reconciliation
• Support multiple API versions → Versioning
• Customize generated code → Code Generation
• Compare frameworks → Framework Comparison

📞 Getting Help

Resources

• GitHub Issues - Report bugs or request features
• Discussions - Ask questions
• API Docs - Package reference
• Examples - Working code samples

Support Channels

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Issues
• ❓ Questions: GitHub Discussions

🤝 Contributing

Help make Fabrica better!

• Contributing Guide - How to contribute
• Releasing Guide - Release process

🚀 What’s Next?

1. Start Building: Follow the Getting Started Guide
2. Explore Examples: Check out the examples directory
3. Join the Community: Participate in GitHub Discussions
4. Contribute: Help improve Fabrica - see the Contributing Guide

---

Ready to build? Start with the Quick Start →