Place utoipa traits and structs behind swagger feature

.github/workflows/ci.yml

@@ -46,6 +46,7 @@ jobs:
             -p cdk --no-default-features,
             -p cdk --no-default-features --features wallet,
             -p cdk --no-default-features --features mint,
+            -p cdk --no-default-features --features "mint swagger",
             -p cdk-redb,
             -p cdk-sqlite,
             -p cdk-axum,
@@ -143,6 +144,7 @@ jobs:
             -p cdk --no-default-features,
             -p cdk --no-default-features --features wallet,
             -p cdk --no-default-features --features mint,
+            -p cdk --no-default-features --features "mint swagger",
             -p cdk-axum,
             -p cdk-strike,
             -p cdk-lnbits,

crates/cdk-axum/Cargo.toml

@@ -15,8 +15,11 @@ axum = "0.6.20"
 cdk = { path = "../cdk", version = "0.4.0", default-features = false, features = ["mint"] }
 tokio = { version = "1", default-features = false }
 tracing = { version = "0.1", default-features = false, features = ["attributes", "log"] }
-utoipa = { version = "4", features = ["preserve_order", "preserve_path_order"] }
+utoipa = { version = "4", features = ["preserve_order", "preserve_path_order"], optional = true }
 futures = { version = "0.3.28", default-features = false }
 moka = { version = "0.11.1", features = ["future"] }
 serde_json = "1"
 paste = "1.0.15"
+
+[features]
+swagger = ["cdk/swagger", "dep:utoipa"]

crates/cdk-axum/src/lib.rs

@@ -38,7 +38,6 @@ use cdk::nuts::nut15::{Mpp, MppMethodSettings};
 use cdk::nuts::{MeltQuoteState, MintQuoteState};
 use moka::future::Cache;
 use router_handlers::*;
-use utoipa::OpenApi;
 
 mod router_handlers;
 
@@ -49,7 +48,8 @@ pub struct MintState {
     cache: Cache<String, String>,
 }
 
-#[derive(OpenApi)]
+#[cfg(feature = "swagger")]
+#[derive(utoipa::OpenApi)]
 #[openapi(
     components(schemas(
         Amount,

crates/cdk-axum/src/router_handlers.rs

@@ -49,14 +49,14 @@ post_cache_wrapper!(post_swap, SwapRequest, SwapResponse);
 post_cache_wrapper!(post_mint_bolt11, MintBolt11Request, MintBolt11Response);
 post_cache_wrapper!(post_melt_bolt11, MeltBolt11Request, MeltQuoteBolt11Response);
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/keys",
     responses(
         (status = 200, description = "Successful response", body = KeysResponse, content_type = "application/json")
     )
-)]
+))]
 /// Get the public keys of the newest mint keyset
 ///
 /// This endpoint returns a dictionary of all supported token values of the mint and their associated public key.
@@ -69,7 +69,7 @@ pub async fn get_keys(State(state): State<MintState>) -> Result<Json<KeysRespons
     Ok(Json(pubkeys))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/keys/{keyset_id}",
@@ -80,7 +80,7 @@ pub async fn get_keys(State(state): State<MintState>) -> Result<Json<KeysRespons
         (status = 200, description = "Successful response", body = KeysResponse, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Get the public keys of a specific keyset
 ///
 /// Get the public keys of the mint from a specific keyset ID.
@@ -96,15 +96,15 @@ pub async fn get_keyset_pubkeys(
     Ok(Json(pubkeys))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/keysets",
     responses(
         (status = 200, description = "Successful response", body = KeysetResponse, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Get all active keyset IDs of the mint
 ///
 /// This endpoint returns a list of keysets that the mint currently supports and will accept tokens from.
@@ -117,7 +117,7 @@ pub async fn get_keysets(State(state): State<MintState>) -> Result<Json<KeysetRe
     Ok(Json(keysets))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/mint/quote/bolt11",
@@ -126,7 +126,7 @@ pub async fn get_keysets(State(state): State<MintState>) -> Result<Json<KeysetRe
         (status = 200, description = "Successful response", body = MintQuoteBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Request a quote for minting of new tokens
 ///
 /// Request minting of new tokens. The mint responds with a Lightning invoice. This endpoint can be used for a Lightning invoice UX flow.
@@ -143,7 +143,7 @@ pub async fn get_mint_bolt11_quote(
     Ok(Json(quote))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/mint/quote/bolt11/{quote_id}",
@@ -154,7 +154,7 @@ pub async fn get_mint_bolt11_quote(
         (status = 200, description = "Successful response", body = MintQuoteBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Get mint quote by ID
 ///
 /// Get mint quote state.
@@ -174,7 +174,7 @@ pub async fn get_check_mint_bolt11_quote(
     Ok(Json(quote))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/mint/bolt11",
@@ -183,7 +183,7 @@ pub async fn get_check_mint_bolt11_quote(
         (status = 200, description = "Successful response", body = MintBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Mint tokens by paying a BOLT11 Lightning invoice.
 ///
 /// Requests the minting of tokens belonging to a paid payment request.
@@ -205,7 +205,7 @@ pub async fn post_mint_bolt11(
     Ok(Json(res))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/melt/quote/bolt11",
@@ -214,7 +214,7 @@ pub async fn post_mint_bolt11(
         (status = 200, description = "Successful response", body = MeltQuoteBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Request a quote for melting tokens
 pub async fn get_melt_bolt11_quote(
     State(state): State<MintState>,
@@ -229,7 +229,7 @@ pub async fn get_melt_bolt11_quote(
     Ok(Json(quote))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/melt/quote/bolt11/{quote_id}",
@@ -240,7 +240,7 @@ pub async fn get_melt_bolt11_quote(
         (status = 200, description = "Successful response", body = MeltQuoteBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Get melt quote by ID
 ///
 /// Get melt quote state.
@@ -260,7 +260,7 @@ pub async fn get_check_melt_bolt11_quote(
     Ok(Json(quote))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/melt/bolt11",
@@ -269,7 +269,7 @@ pub async fn get_check_melt_bolt11_quote(
         (status = 200, description = "Successful response", body = MeltQuoteBolt11Response, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Melt tokens for a Bitcoin payment that the mint will make for the user in exchange
 ///
 /// Requests tokens to be destroyed and sent out via Lightning.
@@ -286,7 +286,7 @@ pub async fn post_melt_bolt11(
     Ok(Json(res))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/checkstate",
@@ -295,7 +295,7 @@ pub async fn post_melt_bolt11(
         (status = 200, description = "Successful response", body = CheckStateResponse, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Check whether a proof is spent already or is pending in a transaction
 ///
 /// Check whether a secret has been spent already or not.
@@ -311,20 +311,20 @@ pub async fn post_check(
     Ok(Json(state))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     get,
     context_path = "/v1",
     path = "/info",
     responses(
         (status = 200, description = "Successful response", body = MintInfo)
     )
-)]
+))]
 /// Mint information, operator contact information, and other info
 pub async fn get_mint_info(State(state): State<MintState>) -> Result<Json<MintInfo>, Response> {
     Ok(Json(state.mint.mint_info().clone().time(unix_time())))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/swap",
@@ -333,7 +333,7 @@ pub async fn get_mint_info(State(state): State<MintState>) -> Result<Json<MintIn
         (status = 200, description = "Successful response", body = SwapResponse, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Swap inputs for outputs of the same value
 ///
 /// Requests a set of Proofs to be swapped for another set of BlindSignatures.
@@ -354,7 +354,7 @@ pub async fn post_swap(
     Ok(Json(swap_response))
 }
 
-#[utoipa::path(
+#[cfg_attr(feature = "swagger", utoipa::path(
     post,
     context_path = "/v1",
     path = "/restore",
@@ -363,7 +363,7 @@ pub async fn post_swap(
         (status = 200, description = "Successful response", body = RestoreResponse, content_type = "application/json"),
         (status = 500, description = "Server error", body = ErrorResponse, content_type = "application/json")
     )
-)]
+))]
 /// Restores blind signature for a set of outputs.
 pub async fn post_restore(
     State(state): State<MintState>,

crates/cdk-mintd/Cargo.toml

@@ -34,5 +34,8 @@ tower-http = { version = "0.4.4", features = ["cors"] }
 lightning-invoice = { version = "0.32.0", features = ["serde", "std"] }
 home = "0.5.5"
 url = "2.3"
-utoipa = "4"
-utoipa-swagger-ui = { version = "4", features = ["axum"] }
+utoipa = { version = "4", optional = true }
+utoipa-swagger-ui = { version = "4", features = ["axum"], optional = true }
+
+[features]
+swagger = ["cdk-axum/swagger", "dep:utoipa", "dep:utoipa-swagger-ui"]

crates/cdk-mintd/src/main.rs

@@ -36,8 +36,6 @@ use tokio::sync::{Mutex, Notify};
 use tower_http::cors::CorsLayer;
 use tracing_subscriber::EnvFilter;
 use url::Url;
-use utoipa::OpenApi;
-use utoipa_swagger_ui::SwaggerUi;
 
 mod cli;
 mod config;
@@ -474,13 +472,17 @@ async fn main() -> anyhow::Result<()> {
     let v1_service = cdk_axum::create_mint_router(Arc::clone(&mint), cache_ttl, cache_tti).await?;
 
     let mut mint_service = Router::new()
-        .merge(
-            SwaggerUi::new("/swagger-ui")
-                .url("/api-docs/openapi.json", cdk_axum::ApiDocV1::openapi()),
-        )
         .merge(v1_service)
         .layer(CorsLayer::permissive());
 
+    #[cfg(feature = "swagger")]
+    {
+        mint_service = mint_service.merge(
+            utoipa_swagger_ui::SwaggerUi::new("/swagger-ui")
+                .url("/api-docs/openapi.json", cdk_axum::ApiDocV1::openapi()),
+        );
+    }
+
     for router in ln_routers {
         mint_service = mint_service.merge(router);
     }

crates/cdk/Cargo.toml

@@ -12,7 +12,8 @@ license = "MIT"
 
 [features]
 default = ["mint", "wallet"]
-mint = ["dep:futures", "dep:utoipa"]
+mint = ["dep:futures"]
+swagger = ["mint", "dep:utoipa"]
 wallet = ["dep:reqwest"]
 bench = []
 

crates/cdk/src/amount.rs

@@ -27,7 +27,7 @@ pub enum Error {
 
 /// Amount can be any unit
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
-#[cfg_attr(feature = "mint", derive(utoipa::ToSchema))]
+#[cfg_attr(feature = "swagger", derive(utoipa::ToSchema))]
 #[serde(transparent)]
 pub struct Amount(u64);
 

crates/cdk/src/error.rs

@@ -244,7 +244,7 @@ pub enum Error {
 ///
 /// See NUT definition in [00](https://github.com/cashubtc/nuts/blob/main/00.md)
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(feature = "mint", derive(utoipa::ToSchema))]
+#[cfg_attr(feature = "swagger", derive(utoipa::ToSchema))]
 pub struct ErrorResponse {
     /// Error Code
     pub code: ErrorCode,
@@ -400,7 +400,7 @@ impl From<ErrorResponse> for Error {
 
 /// Possible Error Codes
 #[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
-#[cfg_attr(feature = "mint", derive(utoipa::ToSchema))]
+#[cfg_attr(feature = "swagger", derive(utoipa::ToSchema))]
 pub enum ErrorCode {
     /// Token is already spent
     TokenAlreadySpent,