custom_router_example/
custom_router_example.rs

1//! Example demonstrating how to attach custom routers to the microkernel server
2//!
3//! This example shows how to use the custom router functionality to extend
4//! the microkernel server with arbitrary endpoints while maintaining
5//! microkernel design principles.
6//!
7//! Run with:
8//! ```bash
9//! cargo run --example custom_router_example
10//! ```
11
12use axum::{
13    Router,
14    extract::Path,
15    response::{Html, Json},
16    routing::{get, post},
17};
18use oauth_provider_rs::{provider_trait::OAuthProviderConfig, GitHubOAuthProvider, OAuthProvider};
19use remote_mcp_kernel::microkernel::{
20    GitHubMicrokernelServer, MicrokernelServer, core::CustomRouterConfig,
21};
22use serde_json::json;
23use std::net::SocketAddr;
24
25/// Custom health check endpoint
26async fn health_check() -> Json<serde_json::Value> {
27    Json(json!({
28        "status": "healthy",
29        "timestamp": std::time::SystemTime::now()
30            .duration_since(std::time::UNIX_EPOCH)
31            .unwrap()
32            .as_secs(),
33        "service": "custom-router-example"
34    }))
35}
36
37/// Custom metrics endpoint
38async fn metrics() -> Json<serde_json::Value> {
39    Json(json!({
40        "uptime": "5 minutes",
41        "requests": 42,
42        "memory_usage": "128MB"
43    }))
44}
45
46/// Custom API endpoint with path parameter
47async fn api_status(Path(version): Path<String>) -> Json<serde_json::Value> {
48    Json(json!({
49        "api_version": version,
50        "status": "operational",
51        "endpoints": [
52            "/health",
53            "/metrics",
54            "/api/v1/status"
55        ]
56    }))
57}
58
59/// Custom admin dashboard endpoint
60async fn admin_dashboard() -> Html<&'static str> {
61    Html(
62        r#"
63        <!DOCTYPE html>
64        <html>
65        <head>
66            <title>Admin Dashboard</title>
67            <style>
68                body { font-family: Arial, sans-serif; margin: 40px; }
69                .card { border: 1px solid #ddd; padding: 20px; margin: 10px 0; border-radius: 5px; }
70                .header { color: #333; }
71            </style>
72        </head>
73        <body>
74            <h1 class="header">Microkernel Admin Dashboard</h1>
75            <div class="card">
76                <h3>Server Status</h3>
77                <p>✅ Microkernel Server: Running</p>
78                <p>✅ OAuth Provider: Connected</p>
79                <p>✅ Custom Routers: 3 attached</p>
80            </div>
81            <div class="card">
82                <h3>Available Endpoints</h3>
83                <ul>
84                    <li><a href="/health">Health Check</a></li>
85                    <li><a href="/monitoring/metrics">Metrics</a></li>
86                    <li><a href="/api/v1/status">API Status</a></li>
87                    <li><a href="/admin">Admin Dashboard</a></li>
88                </ul>
89            </div>
90        </body>
91        </html>
92    "#,
93    )
94}
95
96/// Custom webhook endpoint
97async fn webhook_handler() -> Json<serde_json::Value> {
98    Json(json!({
99        "message": "Webhook received",
100        "processed": true,
101        "timestamp": std::time::SystemTime::now()
102            .duration_since(std::time::UNIX_EPOCH)
103            .unwrap()
104            .as_secs()
105    }))
106}
107
108#[tokio::main]
109async fn main() -> Result<(), Box<dyn std::error::Error>> {
110    // Initialize tracing for logging
111    tracing_subscriber::fmt::init();
112
113    // Create GitHub OAuth provider
114    let github_config = OAuthProviderConfig::with_oauth_config(
115        std::env::var("GITHUB_CLIENT_ID")
116            .unwrap_or_else(|_| "demo_client_id".to_string()),
117        std::env::var("GITHUB_CLIENT_SECRET")
118            .unwrap_or_else(|_| "demo_client_secret".to_string()),
119        "http://localhost:8080/oauth/callback".to_string(),
120        "read:user".to_string(),
121        "github".to_string(),
122    );
123
124    let github_oauth_provider = GitHubOAuthProvider::new_github(github_config);
125    let oauth_provider = OAuthProvider::new(github_oauth_provider, oauth_provider_rs::http_integration::config::OAuthProviderConfig::default());
126
127    // Create custom routers
128
129    // 1. Health and basic endpoints router
130    let health_router = Router::new()
131        .route("/health", get(health_check))
132        .route("/webhooks", post(webhook_handler));
133
134    // 2. Monitoring router with path prefix
135    let monitoring_router = Router::new().route("/metrics", get(metrics));
136
137    // 3. API router with versioned endpoints
138    let api_router = Router::new()
139        .route("/v1/status", get(api_status))
140        .route("/{version}/status", get(api_status));
141
142    // 4. Admin router with HTML interface
143    let admin_router = Router::new().route("/", get(admin_dashboard));
144
145    // Configure custom routers with different configurations
146    let custom_routers = vec![
147        // Health router without prefix (attached to root)
148        (health_router, CustomRouterConfig::default()),
149        // Monitoring router with prefix and name
150        (
151            monitoring_router,
152            CustomRouterConfig::with_name_and_prefix("Monitoring", "/monitoring"),
153        ),
154        // API router with prefix
155        (
156            api_router,
157            CustomRouterConfig::with_name_and_prefix("API", "/api"),
158        ),
159        // Admin router with prefix
160        (
161            admin_router,
162            CustomRouterConfig::with_name_and_prefix("Admin Dashboard", "/admin"),
163        ),
164    ];
165
166    // Build the microkernel server with OAuth provider and custom routers
167    let microkernel: GitHubMicrokernelServer = MicrokernelServer::new()
168        .with_oauth_provider(oauth_provider)
169        .with_custom_routers(custom_routers);
170
171    // Define the bind address
172    let bind_address: SocketAddr = "127.0.0.1:8080".parse()?;
173
174    // Print available endpoints
175    println!("🚀 Starting microkernel server with custom routers...");
176    println!("📍 Server listening on: http://{}", bind_address);
177    println!("\n📋 Available endpoints:");
178    println!("  OAuth:");
179    println!("    GET  /oauth/login");
180    println!("    GET  /oauth/callback");
181    println!("    POST /oauth/token");
182    println!("  Custom Endpoints:");
183    println!("    GET  /health                  - Health check");
184    println!("    POST /webhooks                - Webhook handler");
185    println!("    GET  /monitoring/metrics      - System metrics");
186    println!("    GET  /api/v1/status           - API status");
187    println!("    GET  /api/{{version}}/status   - Versioned API status");
188    println!("    GET  /admin                   - Admin dashboard");
189    println!("\n🔧 Try these commands:");
190    println!("  curl http://localhost:8080/health");
191    println!("  curl http://localhost:8080/monitoring/metrics");
192    println!("  curl http://localhost:8080/api/v1/status");
193    println!("  open http://localhost:8080/admin");
194
195    // Start the server
196    microkernel.serve(bind_address).await?;
197
198    Ok(())
199}
custom_router_example/custom_router_example.rs

custom_router_example/
custom_router_example.rs
