Chore update examples (#1121)

This commit updates examples to use the latest available functionality such as nesting and `utoipa-axum` in case of todo-axum.
juhaku · Oct 14, 2024 · 2389d18 · 2389d18
1 parent cbf08cd
commit 2389d18
Show file tree

Hide file tree

Showing 21 changed files with 120 additions and 226 deletions.
diff --git a/examples/actix-web-multiple-api-docs-with-scopes/Cargo.toml b/examples/actix-web-multiple-api-docs-with-scopes/Cargo.toml
@@ -14,7 +14,7 @@ authors = [
 actix-web = "4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-env_logger = "0.10.0"
+env_logger = "0.11.0"
 log = "0.4"
 futures = "0.3"
 utoipa = { path = "../../utoipa", features = ["actix_extras"] }

diff --git a/examples/rocket-0_4-hello/Cargo.toml b/examples/rocket-0_4-hello/Cargo.toml
diff --git a/examples/rocket-0_4-hello/README.md b/examples/rocket-0_4-hello/README.md
diff --git a/examples/rocket-0_4-hello/rust-toolchain.toml b/examples/rocket-0_4-hello/rust-toolchain.toml
diff --git a/examples/rocket-0_4-hello/src/main.rs b/examples/rocket-0_4-hello/src/main.rs
diff --git a/examples/rocket-todo/Cargo.toml b/examples/rocket-todo/Cargo.toml
@@ -17,7 +17,6 @@ utoipa-rapidoc = { path = "../../utoipa-rapidoc", features = ["rocket"] }
 utoipa-scalar = { path = "../../utoipa-scalar", features = ["rocket"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-env_logger = "0.10.0"
 log = "0.4"
 
 [workspace]
diff --git a/examples/rocket-todo/src/main.rs b/examples/rocket-todo/src/main.rs
@@ -14,19 +14,10 @@ use crate::todo::TodoStore;
 
 #[rocket::launch]
 fn rocket() -> Rocket<Build> {
-    env_logger::init();
-
     #[derive(OpenApi)]
     #[openapi(
-        paths(
-            todo::get_tasks,
-            todo::create_todo,
-            todo::mark_done,
-            todo::delete_todo,
-            todo::search_todos,
-        ),
-        components(
-            schemas(todo::Todo, todo::TodoError)
+        nest(
+            (path = "/api/todo", api = todo::TodoApi)
         ),
         tags(
             (name = "todo", description = "Todo management endpoints.")
@@ -49,7 +40,7 @@ fn rocket() -> Rocket<Build> {
 
     rocket::build()
         .manage(TodoStore::default())
-        .register("/todo", catchers![unauthorized])
+        .register("/api/todo", catchers![unauthorized])
         .mount(
             "/",
             SwaggerUi::new("/swagger-ui/<_..>").url("/api-docs/openapi.json", ApiDoc::openapi()),
@@ -65,7 +56,7 @@ fn rocket() -> Rocket<Build> {
         .mount("/", Redoc::with_url("/redoc", ApiDoc::openapi()))
         .mount("/", Scalar::with_url("/scalar", ApiDoc::openapi()))
         .mount(
-            "/todo",
+            "/api/todo",
             routes![
                 todo::get_tasks,
                 todo::create_todo,
@@ -97,7 +88,11 @@ mod todo {
         FromForm, Request, State,
     };
     use serde::{Deserialize, Serialize};
-    use utoipa::{IntoParams, ToSchema};
+    use utoipa::{IntoParams, OpenApi, ToSchema};
+
+    #[derive(OpenApi)]
+    #[openapi(paths(get_tasks, create_todo, mark_done, delete_todo, search_todos,))]
+    pub struct TodoApi;
 
     pub(super) type TodoStore = Arc<Mutex<Vec<Todo>>>;
 
@@ -173,7 +168,6 @@ mod todo {
 
     /// List all available todo items.
     #[utoipa::path(
-        context_path = "/todo",
         responses(
             (status = 200, description = "Get all todos", body = [Todo])
         )
@@ -187,8 +181,6 @@ mod todo {
     ///
     /// Create new todo item and add it to the storage.
     #[utoipa::path(
-        context_path = "/todo",
-        request_body = Todo,
         responses(
             (status = 201, description = "Todo item created successfully", body = Todo),
             (status = 409, description = "Todo already exists", body = TodoError, example = json!(TodoError::Conflict(String::from("id = 1"))))
@@ -216,7 +208,6 @@ mod todo {
     /// Tries to find todo item by given id and mark it done if found. Will return not found in case todo
     /// item does not exists.
     #[utoipa::path(
-        context_path = "/todo",
         responses(
             (status = 200, description = "Todo item marked done successfully"),
             (status = 404, description = "Todo item not found from storage", body = TodoError, example = json!(TodoError::NotFound(String::from("id = 1"))))
@@ -252,7 +243,6 @@ mod todo {
     ///
     /// Delete Todo from storage by Todo id if found.
     #[utoipa::path(
-        context_path = "/todo",
         responses(
             (status = 200, description = "Todo deleted successfully"),
             (status = 401, description = "Unauthorized to delete Todos", body = TodoError, example = json!(TodoError::Unauthorized(String::from("id = 1")))),
@@ -294,7 +284,6 @@ mod todo {
     ///
     /// Search is performed in case sensitive manner from value of Todo.
     #[utoipa::path(
-        context_path = "/todo",
         params(
             SearchParams
         ),

diff --git a/examples/todo-actix/src/todo.rs b/examples/todo-actix/src/todo.rs
@@ -11,17 +11,14 @@ use utoipa::{IntoParams, OpenApi, ToSchema};
 use crate::{LogApiKey, RequireApiKey};
 
 #[derive(OpenApi)]
-#[openapi(
-    paths(
-        get_todos,
-        create_todo,
-        delete_todo,
-        get_todo_by_id,
-        update_todo,
-        search_todos
-    ),
-    components(schemas(Todo, TodoUpdateRequest, ErrorResponse))
-)]
+#[openapi(paths(
+    get_todos,
+    create_todo,
+    delete_todo,
+    get_todo_by_id,
+    update_todo,
+    search_todos
+))]
 pub(super) struct TodoApi;
 
 #[derive(Default)]
@@ -202,7 +199,6 @@ async fn get_todo_by_id(id: Path<i32>, todo_store: Data<TodoStore>) -> impl Resp
 /// updated according `TodoUpdateRequest` and updated `Todo` is returned with status 200.
 /// If todo is not found then 404 not found is returned.
 #[utoipa::path(
-    request_body = TodoUpdateRequest,
     responses(
         (status = 200, description = "Todo updated successfully", body = Todo),
         (status = 404, description = "Todo not found by id", body = ErrorResponse, example = json!(ErrorResponse::NotFound(String::from("id = 1"))))

diff --git a/examples/todo-axum/Cargo.toml b/examples/todo-axum/Cargo.toml
@@ -4,25 +4,22 @@ description = "Simple axum todo example api with utoipa and Swagger UI, Rapidoc,
 version = "0.1.0"
 edition = "2021"
 license = "MIT"
-authors = [
-  "Elli Example <example@example.com>"
-]
+authors = ["Elli Example <example@example.com>"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 axum = "0.7"
 hyper = { version = "1.0.1", features = ["full"] }
 tokio = { version = "1.17", features = ["full"] }
-tower = "0.4"
+tower = "0.5"
 utoipa = { path = "../../utoipa", features = ["axum_extras"] }
 utoipa-swagger-ui = { path = "../../utoipa-swagger-ui", features = ["axum"] }
+utoipa-axum = { path = "../../utoipa-axum" }
 utoipa-redoc = { path = "../../utoipa-redoc", features = ["axum"] }
 utoipa-rapidoc = { path = "../../utoipa-rapidoc", features = ["axum"] }
 utoipa-scalar = { path = "../../utoipa-scalar", features = ["axum"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
-env_logger = "0.11"
-log = "0.4"
 
 [workspace]
diff --git a/examples/todo-axum/README.md b/examples/todo-axum/README.md
@@ -16,9 +16,3 @@ Scalar can be reached on `http://localhost:8080/scalar`.
 ```bash
 cargo run
 ```
-
-If you want to see some logging, you may prepend the command with `RUST_LOG=debug` as shown below.
-
-```bash
-RUST_LOG=debug cargo run
-```