# Revoke
[](https://github.com/your-org/revoke/actions)
[](https://opensource.org/licenses/MIT)
[](https://www.rust-lang.org)
[](https://hub.docker.com/r/your-org/revoke)
基于 Rust 构建的高性能云原生微服务框架,提供完整的 API 网关和微服务开发工具链。
## 🚀 快速开始
```bash
# 添加到您的项目
[dependencies]
revoke = { version = "0.1", features = ["full"] }
```
```rust
use revoke::prelude::*;
#[tokio::main]
async fn main() -> Result<()> {
let service = MyService::new();
service.start().await
}
```
## ✨ 核心特性
- 🔥 **高性能** - 基于 Pingora 的高吞吐量 API 网关
- ⚖️ **负载均衡** - 多种负载均衡策略
- 🔍 **服务发现** - Consul 集成
- 🔐 **安全性** - JWT、OAuth2、限流、熔断
- 📊 **可观测性** - Prometheus、Jaeger 追踪
- 🐳 **云原生** - Docker 和 Kubernetes 支持
## 📦 组件
- **Gateway** - 高性能 API 网关
- **Web** - Web 服务框架
- **Config** - 配置管理
- **Metrics** - 指标收集
- **Tracing** - 分布式追踪
- **Registry** - 服务注册发现
## 📚 文档
- **[完整文档](./docs/README.md)** - 详细的使用指南
- **[快速入门](./docs/getting-started.md)** - 5分钟上手
- **[配置指南](./docs/configuration.md)** - 配置参考
- **[框架使用](./docs/USAGE.md)** - 开发指南
## 🏗️ 项目结构
```
crates/
├── revoke_core/ # 核心抽象和工具
├── gateway/ # API 网关实现
├── web/ # Web 框架
├── config/ # 配置管理
├── metrics/ # 指标收集
├── tracing/ # 分布式追踪
└── registry/ # 服务发现
```
## 💡 示例
查看 [`examples/`](./examples/) 目录了解完整的使用示例。
## 🤝 贡献
欢迎贡献!请查看我们的[贡献指南](./docs/contributing.md)。
## 📄 许可证
本项目采用 MIT 许可证 - 详情请参阅 [LICENSE](./LICENSE) 文件。