Welcome to the EchoNext documentation! This comprehensive guide will help you build type-safe, well-documented APIs with automatic OpenAPI generation.
- Installation - Install and set up EchoNext
- Quick Start - Build your first API in 5 minutes
- Core Concepts - Understand EchoNext fundamentals
- API Development - Build robust APIs
- Request Validation - Validate requests with struct tags
- OpenAPI Generation - Generate API documentation
- Error Handling - Handle errors gracefully
- Middleware - Use and create middleware
- File Uploads - Type-safe file uploads with OpenAPI docs
- WebSocket - Real-time communication with Hub pattern
- GraphQL - GraphQL integration with gqlgen
- Testing - Test your EchoNext applications
- Deployment - Deploy to production
- CLI Overview - Introduction to the CLI tool
- Project Initialization - Create new projects
- Code Generation - Generate domains, handlers, services
- Database Commands - Manage databases and migrations
- Database - GORM helpers, repository pattern, and Atlas migrations
- Config - Configuration management with Viper
- Testing - APIClient, fixtures, factories, and test suites
- Middleware - RequestID, metrics, logging, and OpenTelemetry
- App API - Core App methods and configuration
- Route Configuration - Route options and handlers
- OpenAPI Types - OpenAPI specification types
- Validation Tags - Available validation tags
- Design Philosophy - Why EchoNext exists
- Architecture Overview - How EchoNext works
- Type System - Type-safe handler design
- OpenAPI Generation - How specs are generated
- Example Projects - Complete example applications
- Common Patterns - Reusable patterns and recipes
- Migration Guide - Migrate from Echo to EchoNext
- Security - Security best practices
- Performance - Optimization techniques
- Observability - Logging, metrics, and tracing
- Microservices - Building microservices
- Contributing Guide - How to contribute
- Development Setup - Set up dev environment
- Code Style - Code standards and conventions
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
- Changelog - Version history and changes
- Roadmap - Future plans
- Main Repository: github.com/abdussamadbello/echonext
- Example Code: examples/
- Issue Tracker: GitHub Issues
- New to EchoNext? Start with Quick Start
- Building an API? Check out API Development Guide
- Using the CLI? See CLI Overview
- Need examples? Browse Example Projects
- Having issues? Check Troubleshooting
This documentation is for EchoNext v1.4.0 and later.
Found an error or want to improve something? Contributions are welcome!
This documentation is licensed under the MIT License, same as EchoNext.