feat: add swagger-ui

ngutech21 · Dec 10, 2023 · 19c9c7e · 19c9c7e
1 parent d473f8e
commit 19c9c7e
Show file tree

Hide file tree

Showing 5 changed files with 176 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/moksha-core/Cargo.toml b/moksha-core/Cargo.toml
@@ -24,6 +24,7 @@ serde_with = "3.4.0"
 thiserror = "1.0.50"
 itertools = "0.12.0"
 uuid = { version = "1.6.1", features = ["serde", "v4"] }
+utoipa = { version = "4.1.0" }
 
 [target.'cfg(target_family = "wasm")'.dependencies]
 # getrandom is transitive dependency of rand

diff --git a/moksha-core/src/primitives.rs b/moksha-core/src/primitives.rs
@@ -7,6 +7,7 @@ use secp256k1::PublicKey;
 use serde::{Deserialize, Serialize};
 use serde_with::skip_serializing_none;
 use std::convert::TryFrom;
+use utoipa::ToSchema;
 use uuid::Uuid;
 
 use crate::{
@@ -120,7 +121,7 @@ pub struct KeyResponse {
     pub keys: HashMap<u64, PublicKey>,
 }
 
-#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Clone)]
+#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Clone, ToSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum CurrencyUnit {
     Sat,
@@ -136,7 +137,7 @@ impl Display for CurrencyUnit {
     }
 }
 
-#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Clone)]
+#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Clone, ToSchema)]
 #[serde(rename_all = "lowercase")]
 pub enum PaymentMethod {
     Bolt11,
@@ -260,19 +261,20 @@ pub struct PostMeltBolt11Response {
 }
 
 #[skip_serializing_none]
-#[derive(Deserialize, Serialize, Debug, PartialEq, Eq)]
+#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, ToSchema)]
 pub struct MintInfoResponse {
     pub name: Option<String>,
+    #[schema(value_type = String)]
     pub pubkey: PublicKey,
     pub version: Option<String>,
     pub description: Option<String>,
     pub description_long: Option<String>,
     pub contact: Option<Vec<Vec<String>>>,
-    pub nuts: Vec<MintInfoNut>,
     pub motd: Option<String>,
+    pub nuts: Vec<MintInfoNut>,
 }
 
-#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Eq)]
+#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Eq, ToSchema)]
 pub enum MintInfoNut {
     /// Cryptography and Models
     #[serde(rename = "0")]

diff --git a/moksha-mint/Cargo.toml b/moksha-mint/Cargo.toml
@@ -45,6 +45,9 @@ envy = "0.4.2"
 fedimint-tonic-lnd = { version = "0.1.3", features = ["lightningrpc"] }
 uuid = { version = "1.6.1", features = ["serde", "v4"] }
 
+utoipa = { version = "4.1.0", features = ["axum_extras"] }
+utoipa-swagger-ui = { version = "5.0.0", features = ["axum"] }
+
 [dev-dependencies]
 tempfile = "3.8.1"
 tower = { version = "0.4", features = ["util"] }

diff --git a/moksha-mint/src/server.rs b/moksha-mint/src/server.rs
@@ -11,6 +11,7 @@ use axum::routing::{get_service, post};
 use axum::{middleware, Router};
 use axum::{routing::get, Json};
 use moksha_core::keyset::{generate_hash, Keysets, V1Keysets};
+use utoipa_swagger_ui::SwaggerUi;
 use uuid::Uuid;
 
 use crate::mint::Mint;
@@ -36,6 +37,8 @@ use tracing::{event, info, Level};
 use tracing_subscriber::prelude::__tracing_subscriber_SubscriberExt;
 use tracing_subscriber::util::SubscriberInitExt;
 
+use utoipa::OpenApi;
+
 pub async fn run_server(
     mint: Mint,
     addr: SocketAddr,
@@ -73,6 +76,13 @@ pub async fn run_server(
     Ok(())
 }
 
+#[derive(OpenApi)]
+#[openapi(
+    paths(get_info,),
+    components(schemas(MintInfoResponse, MintInfoNut, CurrencyUnit, PaymentMethod))
+)]
+struct ApiDoc;
+
 fn app(mint: Mint, serve_wallet_path: Option<PathBuf>, prefix: Option<String>) -> Router {
     let legacy_routes = Router::new()
         .route("/keys", get(get_legacy_keys))
@@ -84,6 +94,7 @@ fn app(mint: Mint, serve_wallet_path: Option<PathBuf>, prefix: Option<String>) -
         .route("/info", get(get_legacy_info));
 
     let routes = Router::new()
+        .merge(SwaggerUi::new("/swagger-ui").url("/api-docs/openapi.json", ApiDoc::openapi()))
         .route("/v1/keys", get(get_keys))
         .route("/v1/keys/:id", get(get_keys_by_id))
         .route("/v1/keysets", get(get_keysets))
@@ -496,6 +507,13 @@ async fn get_melt_quote_bolt11(
     }
 }
 
+#[utoipa::path(
+        get,
+        path = "/v1/info",
+        responses(
+            (status = 200, description = "get mint info", body = [MintInfoResponse])
+        )
+    )]
 async fn get_info(State(mint): State<Mint>) -> Result<Json<MintInfoResponse>, MokshaMintError> {
     let mint_info = MintInfoResponse {
         name: mint.mint_info.name,