...

use utoipauto::utoipauto;

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

pub struct ApiDoc;

...

从模块导入

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

use utoipauto::utoipauto;

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

pub struct ApiDoc;

以下是如何添加位于子文件夹中的rest模块中包含的所有方法和结构的示例

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(...)] 属性的函数，但您也可以指定要查找的自定义属性。

#[handler]
pub fn custom_router() {
    // ...
}

#[utoipauto(function_attribute_name = "handler")] //Custom attribute
#[derive(OpenApi)]
#[openapi(tags()))]
pub struct ApiDoc;

您还可以指定模型和响应检测的自定义属性。

#[derive(Schema, Response)]
pub struct CustomModel {
    // ...
}

#[utoipauto(schema_attribute_name = "Schema", response_attribute_name = "Response")] //Custom derive
#[derive(OpenApi)]
#[openapi(tags())]
pub struct ApiDoc;

注意

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

贡献

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

灵感来源

灵感来源于 utoipa_auto_discovery