Feature based openapi ApiDocs in Utoipa?

roshan · June 22, 2024, 4:05am

Is it possible to conditionally include paths, components using Utoipa. I want the openapi specification that is generated to be feature based.

Consider this example -

github.com

juhaku/utoipa/blob/master/examples/todo-axum/src/main.rs#L73


      
              response::IntoResponse,
              routing, Json, Router,
          };
          use hyper::{HeaderMap, StatusCode};
          use serde::{Deserialize, Serialize};
          use tokio::sync::Mutex;
          use utoipa::{IntoParams, OpenApi, ToSchema};
          
          #[derive(OpenApi)]
          #[openapi(
              paths(list_todos, search_todos, create_todo, mark_done, delete_todo,),
              components(schemas(Todo, TodoError))
          )]
          pub(super) struct TodoApi;
          
          /// In-memory todo store
          type Store = Mutex<Vec<Todo>>;
          
          /// Item to do.
          #[derive(Serialize, Deserialize, ToSchema, Clone)]
          struct Todo {

If feature = "read" only list_todos, search_todos should be generated.
If feature = "write" only create_todo, delete_todo, mark_done should be generated.

Does anyone know if that is possible with utoipa?

Thanks,
Roshan.

jofas · June 22, 2024, 4:58am

You can use cfg_attr for this.

#[derive(OpenApi)]
#[openapi(components(schemas(Todo, TodoError))]
#[cfg_attr(feature = "write", openapi(paths(create_todo, mark_done, delete_todo)))]
#[cfg_attr(feature = "read", openapi(paths(list_todos, search_todos)))]
pub(super) struct TodoApi;

Topic		Replies	Views
How to create common HTTP Response examples in utoipa (Swagger) help	0	109	May 14, 2024
Openapi-generator: How to deal with generated `ApiError`? help	3	376	January 11, 2024
Adding header to a http request with Swagger help	5	1234	February 8, 2024
Idiomatically using optional features in an app help	3	286	December 30, 2022
Builder pattern question help	6	2013	January 12, 2023

Feature based openapi ApiDocs in Utoipa?

Related Topics