Use default values as examples in OpenAPI

zino-rs · Aug 31, 2024 · e73e435 · e73e435
1 parent 5ebd871
commit e73e435
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 24 deletions.
diff --git a/zino-cli/Cargo.toml b/zino-cli/Cargo.toml
@@ -18,7 +18,6 @@ name = "zli"
 path = "src/main.rs"
 
 [dependencies]
-env_logger = "0.11.5"
 git2 = "0.19.0"
 include_dir = "0.7.4"
 log = "0.4.22"

diff --git a/zino-cli/src/main.rs b/zino-cli/src/main.rs
@@ -1,19 +1,10 @@
 use clap::Parser;
-use std::env;
 use zino_cli::{Cli, Subcommands::*};
 
 fn main() {
-    env::set_var("RUST_LOG", "info");
-
     let result = match Cli::parse().action() {
-        Init(opts) => {
-            env_logger::init();
-            opts.run()
-        }
-        New(opts) => {
-            env_logger::init();
-            opts.run()
-        }
+        Init(opts) => opts.run(),
+        New(opts) => opts.run(),
         Serve(opts) => opts.run(),
     };
     if let Err(err) = result {

diff --git a/zino-core/Cargo.toml b/zino-core/Cargo.toml
@@ -226,7 +226,7 @@ version = "0.5.3"
 features = ["std"]
 
 [dependencies.async-openai]
-version = "0.23.4"
+version = "0.24.0"
 optional = true
 
 [dependencies.card-validate]
@@ -271,7 +271,7 @@ version = "0.5.2"
 optional = true
 
 [dependencies.jwt-simple]
-version = "0.12.9"
+version = "0.12.10"
 optional = true
 default-features = false
 features = ["pure-rust"]
@@ -292,7 +292,7 @@ optional = true
 features = ["debug", "loader"]
 
 [dependencies.opendal]
-version = "0.49.1"
+version = "0.49.2"
 optional = true
 default-features = false
 features = ["layers-tracing"]
@@ -437,7 +437,7 @@ criterion = "0.5.1"
 data-encoding = "2.6.0"
 libsm = "0.6.0"
 sm3 = "0.4.2"
-sonic-rs = "0.3.11"
+sonic-rs = "0.3.12"
 tinyvec = { version = "1.8.0", features = ["alloc"] }
 uuid-simd = "0.8.0"
 

diff --git a/zino-core/src/openapi/parser.rs b/zino-core/src/openapi/parser.rs
@@ -197,7 +197,10 @@ pub(super) fn parse_schema(config: &Table) -> Schema {
     let mut object_builder = ObjectBuilder::new().schema_type(schema_type);
     for (key, value) in config {
         if key == "default" {
-            object_builder = object_builder.default(Some(value.to_json_value()));
+            let default_value = value.to_json_value();
+            object_builder = object_builder
+                .default(Some(default_value.clone()))
+                .example(Some(default_value));
         } else if key == "example" {
             object_builder = object_builder.example(Some(value.to_json_value()));
         } else {
@@ -325,7 +328,10 @@ fn parse_array_schema(config: &Table) -> Array {
     let mut array_builder = ArrayBuilder::new().items(item_schema);
     for (key, value) in config {
         if key == "default" {
-            array_builder = array_builder.default(Some(value.to_json_value()));
+            let default_value = value.to_json_value();
+            array_builder = array_builder
+                .default(Some(default_value.clone()))
+                .example(Some(default_value));
         } else if key == "example" {
             array_builder = array_builder.example(Some(value.to_json_value()));
         } else {
@@ -466,7 +472,11 @@ fn parse_query_parameters(query: &Table) -> Vec<Parameter> {
             } else {
                 parse_schema(config).into()
             };
-            parameter_builder = parameter_builder.schema(Some(schema));
+            parameter_builder = parameter_builder
+                .schema(Some(schema))
+                .description(config.get_str("description"))
+                .explode(config.get_bool("explode"))
+                .allow_reserved(config.get_bool("allow_reserved"));
         } else if let Some(basic_type) = value.as_str() {
             let object = Object::with_type(parse_schema_type(basic_type));
             parameter_builder = parameter_builder.schema(Some(object));
@@ -489,7 +499,11 @@ fn parse_header_parameters(headers: &Table) -> Vec<Parameter> {
             } else {
                 parse_schema(config).into()
             };
-            parameter_builder = parameter_builder.schema(Some(schema));
+            parameter_builder = parameter_builder
+                .schema(Some(schema))
+                .description(config.get_str("description"))
+                .explode(config.get_bool("explode"))
+                .allow_reserved(config.get_bool("allow_reserved"));
         } else if let Some(basic_type) = value.as_str() {
             let object = Object::with_type(parse_schema_type(basic_type));
             parameter_builder = parameter_builder.schema(Some(object));
@@ -512,7 +526,11 @@ fn parse_cookie_parameters(cookies: &Table) -> Vec<Parameter> {
             } else {
                 parse_schema(config).into()
             };
-            parameter_builder = parameter_builder.schema(Some(schema));
+            parameter_builder = parameter_builder
+                .schema(Some(schema))
+                .description(config.get_str("description"))
+                .explode(config.get_bool("explode"))
+                .allow_reserved(config.get_bool("allow_reserved"));
         } else if let Some(basic_type) = value.as_str() {
             let object = Object::with_type(parse_schema_type(basic_type));
             parameter_builder = parameter_builder.schema(Some(object));

diff --git a/zino-derive/Cargo.toml b/zino-derive/Cargo.toml
@@ -17,7 +17,7 @@ proc-macro = true
 convert_case = "0.6.0"
 proc-macro2 = "1.0.86"
 quote = "1.0.37"
-syn = "2.0.76"
+syn = "2.0.77"
 
 [dependencies.zino-core]
 path = "../zino-core"

diff --git a/zino-dioxus/Cargo.toml b/zino-dioxus/Cargo.toml
@@ -42,7 +42,7 @@ version = "0.5.0"
 optional = true
 
 [dependencies.tokio]
-version = "1.39.3"
+version = "1.40.0"
 features = ["time"]
 
 [dependencies.uuid]

diff --git a/zino/Cargo.toml b/zino/Cargo.toml
@@ -150,7 +150,7 @@ version = "2.0.0"
 optional = true
 
 [dependencies.tokio]
-version = "1.39.3"
+version = "1.40.0"
 optional = true
 features = [
     "macros",