Optional prefix

poem-web · Jan 17, 2023 · 717f407 · 717f407
1 parent 7ada5b6
commit 717f407
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/poem-openapi/src/openapi.rs b/poem-openapi/src/openapi.rs
@@ -221,6 +221,7 @@ pub struct OpenApiService<T, W> {
     cookie_key: Option<CookieKey>,
     extra_response_headers: Vec<(ExtraHeader, MetaSchemaRef, bool)>,
     extra_request_headers: Vec<(ExtraHeader, MetaSchemaRef, bool)>,
+    url_prefix: Option<String>,
 }
 
 impl<T> OpenApiService<T, ()> {
@@ -244,6 +245,7 @@ impl<T> OpenApiService<T, ()> {
             cookie_key: None,
             extra_response_headers: vec![],
             extra_request_headers: vec![],
+            url_prefix: None,
         }
     }
 }
@@ -260,6 +262,7 @@ impl<T, W> OpenApiService<T, W> {
             cookie_key: self.cookie_key,
             extra_response_headers: self.extra_response_headers,
             extra_request_headers: self.extra_request_headers,
+            url_prefix: None,
         }
     }
 
@@ -373,6 +376,14 @@ impl<T, W> OpenApiService<T, W> {
         }
     }
 
+    /// Sets optional URl prefix to be added to path
+    pub fn url_prefix(self, url_prefix: impl Into<String>) -> Self {
+        Self {
+            url_prefix: Some(url_prefix.into()),
+            ..self
+        }
+    }
+
     /// Create the OpenAPI Explorer endpoint.
     #[must_use]
     #[cfg(feature = "openapi-explorer")]
@@ -554,6 +565,7 @@ impl<T, W> OpenApiService<T, W> {
             webhooks,
             registry,
             external_document: self.external_document.as_ref(),
+            url_prefix: self.url_prefix.as_deref(),
         };
         doc.remove_unused_schemas();
 

diff --git a/poem-openapi/src/registry/ser.rs b/poem-openapi/src/registry/ser.rs
@@ -22,14 +22,17 @@ impl Serialize for MetaSchemaRef {
     }
 }
 
-struct PathMap<'a>(&'a [MetaApi]);
+struct PathMap<'a>(&'a [MetaApi], Option<&'a str>);
 
 impl<'a> Serialize for PathMap<'a> {
     fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
         let mut s = serializer.serialize_map(Some(self.0.len()))?;
         for api in self.0 {
             for path in &api.paths {
-                s.serialize_entry(path.path, path)?;
+                match self.1 {
+                    Some(p) => s.serialize_entry(&format!("{}{}", p, path.path), path)?,
+                    None => s.serialize_entry(path.path, path)?,
+                }
             }
         }
         s.end()
@@ -80,6 +83,7 @@ pub(crate) struct Document<'a> {
     pub(crate) webhooks: Vec<MetaWebhook>,
     pub(crate) registry: Registry,
     pub(crate) external_document: Option<&'a MetaExternalDocument>,
+    pub(crate) url_prefix: Option<&'a str>,
 }
 
 impl<'a> Serialize for Document<'a> {
@@ -101,7 +105,7 @@ impl<'a> Serialize for Document<'a> {
         if !self.webhooks.is_empty() {
             s.serialize_entry("webhooks", &WebhookMap(&self.webhooks))?;
         }
-        s.serialize_entry("paths", &PathMap(&self.apis))?;
+        s.serialize_entry("paths", &PathMap(&self.apis, self.url_prefix))?;
         s.serialize_entry(
             "components",
             &Components {