server: documentation part 1

crates/brk_server/src/api/mod.rs

@@ -1,4 +1,5 @@
-use axum::{Router, response::Redirect, routing::get};
+use aide::axum::ApiRouter;
+use axum::{response::Html, routing::get};
 
 use crate::api::{chain::ApiExplorerRoutes, metrics::ApiMetricsRoutes};
 
@@ -11,17 +12,10 @@ pub trait ApiRoutes {
     fn add_api_routes(self) -> Self;
 }
 
-impl ApiRoutes for Router<AppState> {
+impl ApiRoutes for ApiRouter<AppState> {
     fn add_api_routes(self) -> Self {
         self.add_api_explorer_routes()
             .add_api_metrics_routes()
-            .route(
-                "/api",
-                get(|| async {
-                    Redirect::temporary(
-                        "https://github.com/bitcoinresearchkit/brk/tree/main/crates/brk_server#api",
-                    )
-                }),
-            )
+            .route("/api", get(Html::from(include_str!("./scalar.html"))))
     }
 }