Merge pull request #511 from that-ambuj/add-openapi-toschema-derive

Derive utoipa::ToSchema by default for generating openapi specs by other libraries

src/generator/lib/util.py

@@ -1199,7 +1199,7 @@ def unique(
     original: str,
     desired: str,
     attempts: int = 0,
-    assigned: dict[str, str] = {},
+    assigned: Dict[str, str] = {},
 ) -> str:
     if original in assigned:
         return assigned[original]

src/generator/templates/Cargo.toml.mako

@@ -31,6 +31,7 @@ hyper-rustls = "0.25.0"
 ## Must match the one hyper uses, otherwise there are duplicate similarly named `Mime` structs
 mime = "^ 0.3.0"
 serde = { version = "^ 1.0", features = ["derive"] }
+utoipa = { version = "^4.2", optional = true }
 serde_json = "^ 1.0"
 itertools = "0.13"
 % if cargo.get('is_executable', False):
@@ -61,4 +62,5 @@ version = "${util.crate_version()}"
 [features]
 yup-oauth2 = ["google-apis-common/yup-oauth2"]
 default = ["yup-oauth2"]
+utoipa = ["dep:utoipa"]
 % endif

src/generator/templates/api/lib/lib.mako

@@ -235,6 +235,13 @@ Arguments will always be copied or cloned into the builder, to make them indepen
 [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
 [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
 [google-go-api]: https://github.com/google/google-api-go-client
+
+${'##'} Cargo Features
+
+* `utoipa` - Add support for [utoipa](https://crates.io/crates/utoipa) and derive `utoipa::ToSchema` on all
+the types. You'll have to import and register the required types in `#[openapi(schemas(...))]`, otherwise the
+generated `openapi` spec would be invalid.
+
 </%def>
 
 ## Sets up a hub ready for use. You must wrap it into a test function for it to work
@@ -308,6 +315,7 @@ ${self.test_hub(hub_type(c.schemas, util.canonical_name()))}
 % endif
 </%def>
 
+
 ###############################################################################################
 ###############################################################################################
 <%def name="license()">\

src/generator/templates/api/lib/schema.mako

@@ -83,6 +83,7 @@ ${struct} { _never_set: Option<bool> }
 <%block filter="rust_doc_sanitize(documentationLink), rust_doc_comment">\
 ${doc(s, c)}\
 </%block>
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 #[serde_with::serde_as(crate = "::client::serde_with")]
 #[derive(${', '.join(traits)})]
 % if s.type == 'object':