它还检测用于components(schemas)部分的派生自ToSchema的结构，以及用于components(responses)部分的ToResponse。

特性

• 自动递归路径检测
• 自动从模块导入
• 自动从src文件夹导入
• 自动模型检测
• 自动响应检测

如何使用它

简单地将crate utoipauto 添加到项目中

cargo add utoipauto

导入宏

use utoipauto::utoipauto;

然后在 #[derive(OpenApi)] 和 #[openapi] 宏之前添加 #[utoipauto] 宏。

重要！！

将 #[utoipauto] 放在 #[derive(OpenApi)] 和 #[openapi] 宏之前。

#[utoipauto(paths = "MODULE_SRC_FILE_PATH, MODULE_SRC_FILE_PATH, ...")]

路径接收一个必须遵循此结构的String

"MODULE_SRC_FILE_PATH, MODULE_SRC_FILE_PATH, ..."

您可以通过逗号 "," 分隔来添加多个路径。

从src文件夹导入

如果没有指定路径，宏将自动扫描 src 文件夹，并添加所有带有 #[utoipa::path(...)] 宏的方法，以及所有继承自 ToSchema 和 ToResponse 的结构体。以下是如何添加src代码中所有方法的示例。

...

use utoipauto::utoipauto;

...
#[utoipauto]
#[derive(OpenApi)]
#[openapi(
    tags(
        (name = "todo", description = "Todo management endpoints.")
    ),
    modifiers(&SecurityAddon)
)]

pub struct ApiDoc;

...

从模块导入

以下是如何添加其余模块中所有方法和结构的示例。

use utoipauto::utoipauto;

#[utoipauto(
  paths = "./src/rest"
  )]
#[derive(OpenApi)]
#[openapi(
    tags(
        (name = "todo", description = "Todo management endpoints.")
    ),
    modifiers(&SecurityAddon)
)]

pub struct ApiDoc;

以下是如何在子文件夹中添加其余模块中所有方法和结构的示例。

use utoipauto::utoipauto;

#[utoipauto(
  paths = "(./src/lib/rest from crate::rest)"
  )]
#[derive(OpenApi)]
#[openapi(
    tags(
        (name = "todo", description = "Todo management endpoints.")
    ),
    modifiers(&SecurityAddon)
)]

pub struct ApiDoc;

从文件名导入

以下是如何添加 test_controller 和 test2_controller 模块中所有方法的示例。您还可以将自动添加和手动添加结合起来，例如，我们在此手动添加了文档中的 "other_controller::get_users" 方法和一个模式 "TestDTO"。

use utoipauto::utoipauto;

#[utoipauto(
  paths = "./src/rest/test_controller.rs,./src/rest/test2_controller.rs "
  )]
#[derive(OpenApi)]
#[openapi(
    paths(

        crate::rest::other_controller::get_users,
    ),
    components(
        schemas(TestDTO)
    ),
    tags(
        (name = "todo", description = "Todo management endpoints.")
    ),
    modifiers(&SecurityAddon)
)]

pub struct ApiDoc;

排除自动扫描的方法

您可以通过添加以下宏 #[utoipa_ignore] 来排除Doc Path列表中的一个函数。

示例

    /// Get all pets from database
    ///
    #[utoipa_ignore]  //<============== this Macro
    #[utoipa::path(
        responses(
            (status = 200, description = "List all Pets", body = [ListPetsDTO])
        )
    )]
    #[get("/pets")]
    async fn get_all_pets(req: HttpRequest, store: web::Data<AppState>) -> impl Responder {
        // your CODE
    }

排除自动扫描的结构

您还可以通过添加以下宏 #[utoipa_ignore] 来排除模型和响应列表中的一个结构。

示例

    #[utoipa_ignore]  //<============== this Macro
    #[derive(ToSchema)]
    struct ModelToIgnore {
        // your CODE
    }

注意

包含带有 utoipa::path 标记的方法的子模块也自动检测。

贡献

欢迎贡献，请随意提交PR或问题。