Zoox 框架文档
欢迎使用 Zoox - 一个轻量级、高性能的 Go Web 框架。
📚 文档导航
🚀 快速开始(新用户必读)
如果你是第一次使用 Zoox,建议按以下顺序阅读:
📖 核心指南
深入了解框架的核心功能:
- 路由系统 - Trie树路由、路由参数、路由组
- 中间件使用 - 中间件概念、内置中间件、自定义中间件
- Context API - 请求处理、响应方法、数据绑定
- 模板引擎 - 模板渲染和自定义函数
- 配置管理 - 环境变量、配置文件、TLS配置
🔧 内置组件
框架提供的开箱即用组件:
🛡️ 中间件
丰富的中间件生态系统:
- 中间件概览 - 中间件系统介绍
- 认证中间件 - JWT、BasicAuth、BearerToken
- 安全中间件 - Helmet、CORS、BodyLimit
- 性能中间件 - Gzip、CacheControl、StaticCache
- 监控中间件 - Prometheus、Sentry、Logger
🚀 高级功能
框架的高级特性:
- WebSocket支持 - 实时通信
- JSON-RPC服务 - JSON-RPC协议支持
- 代理功能 - 反向代理和路径重写
- 定时任务 - Cron任务调度
- 任务队列 - 后台任务处理
- 发布订阅 - Pub/Sub消息系统
- 消息队列 - MQ消息处理
📚 API 参考
完整的API文档:
- Application API - 应用实例方法、配置、组件访问
- Context API - 上下文方法、请求响应处理
- Router API - 路由注册、路由组、静态文件
- 中间件列表 - 所有内置中间件完整列表
💡 示例项目
实际项目示例,包含完整可运行的代码:
- RESTful API - 完整的用户管理 REST API,包含认证、CRUD操作
- WebSocket 应用 - WebSocket 实时聊天应用,支持多用户
- 静态文件服务 - 静态文件服务示例,包含缓存、压缩等配置
- JSON-RPC 服务器 - JSON-RPC 2.0 服务器示例,包含批量请求和错误处理
- API Gateway - API 网关示例,包含路由、认证、限流、聚合等功能
- 微服务架构 - 微服务架构示例,包含 Gateway 和多个服务
🎯 最佳实践
- 最佳实践指南 - 项目结构、错误处理、性能优化
🔗 相关链接
📝 文档贡献
欢迎贡献文档!如果你发现文档有任何问题或需要改进,请提交 Issue 或 Pull Request。
