Yelix Getting Started
Yelix is a powerful abstraction layer built on top of Hono, designed to enhance your API development experience while maintaining full compatibility with Hono’s core features.
What Yelix Does
Section titled “What Yelix Does”Yelix extends Hono with several powerful features:
- Automatic OpenAPI Documentation: Generate comprehensive OpenAPI specifications automatically from your route definitions
- Enhanced Middleware System: Named middleware with execution time tracking and better debugging capabilities
- Zod Integration: Seamless integration with Zod for request validation and automatic schema generation
- Scalar UI Support: Built-in support for beautiful, interactive API documentation with Scalar
- Better Logging: Enhanced logging with request/response tracking and middleware execution monitoring
- Type Safety: Improved TypeScript support with better type inference
What Yelix Doesn’t Do
Section titled “What Yelix Doesn’t Do”Yelix doesn’t replace Hono’s core functionality. It builds on top of it:
- Routing: Uses Hono’s routing system (fully compatible)
- Context Management: Uses Hono’s context for query params, headers, etc.
- Core Middleware: Compatible with all Hono middleware
Why Use Yelix?
Section titled “Why Use Yelix?”If you’re building APIs with Hono and need:
- Automatic API documentation
- Better middleware debugging
- Enhanced type safety with Zod
- Professional API documentation UI
Then Yelix is the perfect choice. It gives you all the power of Hono plus the tools you need to build production-ready APIs.
Next Steps
Section titled “Next Steps”Ready to get started? Check out our Quick Start Guide to build your first Yelix application in minutes.