Salvo框架中OpenAPI安全认证的配置与使用

概述

在Salvo框架中配置OpenAPI的安全认证是一个常见的需求，特别是当我们需要为API接口添加统一的认证机制时。本文将详细介绍如何在Salvo项目中正确配置OpenAPI的安全认证方案，包括安全架构的定义和安全要求的应用。

安全架构定义

在Salvo中，我们可以通过OpenApi构建器来定义安全架构。以下是一个典型的示例，展示了如何添加两种常见的安全认证方案：

let open_api = OpenApi::new("test api", "0.0.1")
    .add_security_scheme(
        "device-id",
        SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
            "device-id",
            &"设备唯一标识".to_string(),
        ))),
    )
    .add_security_scheme(
        "authorization",
        SecurityScheme::ApiKey(ApiKey::Header(ApiKeyValue::with_description(
            "authorization",
            &"JWT认证令牌".to_string(),
        ))),
    );

这段代码定义了两个安全方案：

1. device-id：通过HTTP头部传递的设备ID
2. authorization：通过HTTP头部传递的JWT令牌

路由级别的安全要求

在Salvo的最新版本中，我们可以通过路由级别的配置来统一应用安全要求，而不需要为每个端点单独设置。这是通过oapi_securities方法实现的：

let security_requirements = vec![
    SecurityRequirement::new("authorization", Vec::<String>::new().into_iter()),
    SecurityRequirement::new("device-id", Vec::<String>::new().into_iter())
];

let router = Router::with_path("api")
    .oapi_securities(security_requirements)
    .push(/* 其他路由 */);

这种配置方式会使得该路由及其所有子路由都继承这些安全要求，大大简化了大规模API的安全配置工作。

端点级别的安全要求

如果需要对特定端点进行更细粒度的控制，也可以在端点级别使用#[endpoint]宏来指定安全要求：

#[endpoint(security(("device-id" = [], "authorization" = [])))]
async fn protected_endpoint(req: &mut Request) {
    // 端点逻辑
}

认证数据的持久化

在Swagger UI中，默认情况下认证数据不会在页面刷新后保留。如果需要保持认证状态，可以配置Swagger UI使用持久化认证：

SwaggerUi::new("/api-doc/openapi.json")
    .config(Config::new().persist_authorization(true))
    .into_router("ui")

最佳实践

1. 统一配置：对于大多数API，推荐在路由级别统一配置安全要求，保持一致性
2. 描述清晰：为每个安全方案添加明确的描述，方便API使用者理解
3. 适当持久化：根据安全需求决定是否启用认证持久化
4. 分层设计：可以将不同安全级别的API放在不同的路由下，分别配置安全要求

通过以上方法，开发者可以灵活地为Salvo项目中的OpenAPI接口配置各种安全认证方案，既保证了安全性，又提供了良好的开发者体验。