EasyMessages Documentation
Welcome to the complete documentation for EasyMessages - a lightweight .NET library for consistent, fluent message management.
Packages
| Package | Version | Description |
|---|---|---|
| RecurPixel.EasyMessages | Unified library for all .NET applications including ASP.NET Core |
Quick Links
New to EasyMessages?
- Getting Started in 5 Minutes - Quick tutorial
- Installation Guide - Setup instructions
- Package Comparison - Which package do you need?
Building Applications?
- Console vs Web Applications - Choose the right approach
- ASP.NET Core Integration - Complete guide
- API Response Patterns - REST API patterns
Configuration & Setup?
- Setup and Configuration - Complete setup guide
- Configuration Presets - Environment-specific configs
- Logging Integration - ILogger integration
Documentation Sections
Getting Started
Step-by-step tutorials to get you up and running quickly.
- Installation
- Your First Message (5 minutes)
- Console vs Web Applications
- Next Steps
Core Concepts
Understand the fundamental concepts behind EasyMessages.
- Messages and Message Types
- Message Registry and Stores
- Facades (Msg.Auth, Msg.Crud, etc.)
- Formatters and Outputs
- Interceptors
- Architecture Overview
ASP.NET Core
Complete guide for ASP.NET Core integration.
- Overview - Package features and quick start
- Setup and Configuration - Installation and configuration
- Configuration Presets - Environment-specific presets
- API Response Patterns - REST API patterns
- Logging Integration - ILogger integration
Package Comparison
Which Package Do I Need?
There is only one package: RecurPixel.EasyMessages — it works for all scenarios.
| Scenario | Package |
|---|---|
| Console Application | RecurPixel.EasyMessages |
| Background Jobs | RecurPixel.EasyMessages |
| Class Library | RecurPixel.EasyMessages |
| ASP.NET Core Web API | RecurPixel.EasyMessages |
| Minimal APIs | RecurPixel.EasyMessages |
Feature List
| Feature | Available |
|---|---|
| Message Creation | [✓] |
| Multiple Output Formats | [✓] |
| Custom Messages | [✓] |
| Custom Formatters | [✓] |
| Custom Interceptors | [✓] |
.ToJsonObject() (for API responses) |
[✓] |
.Log(ILogger) |
[✓] |
| No DI registration needed | [✓] |
Documentation Conventions
Throughout this wiki, we use these conventions:
- Code blocks show working examples you can copy-paste
- **Note: Tips** highlight best practices and shortcuts
- **Warning: Warnings** point out common pitfalls
- Notes provide additional context
- Links are provided for related topics
🤝 Contributing
Found an issue in the documentation? Have a suggestion?
License
EasyMessages is licensed under the MIT License.
Documentation Status
| Section | Status | Pages | Notes |
|---|---|---|---|
| Getting Started | [✓] Complete | 4 pages | Ready to use |
| Core Concepts | [✓] Complete | 6 pages | Comprehensive coverage |
| ASP.NET Core | [✓] Complete | 5 pages | Full integration guide |
| How-To Guides | 📋 Planned | - | Coming soon |
| Examples | 📋 Planned | - | Coming soon |
| API Reference | 📋 Planned | - | Coming soon |
| Advanced Topics | 📋 Planned | - | Coming soon |
| Migration Guides | 📋 Planned | - | Coming soon |
Last Updated: 2026-01-10 Current Version: 1.0.0 Status: Stable Release Documentation: 15 pages created, 30,000+ lines