OpenAPI-MCP-Generator 中如何正确传递授权头信息

OpenAPI-MCP-Generator 中如何正确传递授权头信息

在 API 开发中，身份验证是一个关键环节。本文将详细介绍在使用 OpenAPI-MCP-Generator 项目时如何正确配置和传递授权头信息，特别是针对 Bearer Token 认证方式。

理解安全方案配置

OpenAPI-MCP-Generator 会根据 OpenAPI 规范中的安全方案定义自动生成对应的验证机制。在生成的代码中，安全方案会被转换为特定的变量命名格式。

例如，当 OpenAPI 规范中定义了如下安全方案：

components:
  securitySchemes:
    local_bearer_auth:
      description: "Optional Bearer token flow"
      type: http
      scheme: bearer

生成器会将其转换为 JavaScript 对象：

"local_bearer_auth": {
  "description": "Optional Bearer token flow",
  "type": "http",
  "scheme": "bearer"
}

环境变量命名规则

要传递授权信息，需要按照特定格式设置环境变量。规则如下：

1. 将认证类型（如 BEARER）转换为大写
2. 将安全方案名称（如 local_bearer_auth）转换为大写
3. 使用下划线连接两者

对于上述示例，正确的环境变量名应为：BEARER_TOKEN_LOCAL_BEARER_AUTH

实际应用示例

假设我们需要为使用 Bearer Token 认证的 API 设置访问令牌：

1. 首先确认 API 规范中定义的安全方案名称
2. 根据命名规则构造环境变量名
3. 设置环境变量值

例如，在 Linux/macOS 终端中：

export BEARER_TOKEN_LOCAL_BEARER_AUTH="your_access_token_here"

或者在 Windows 命令提示符中：

set BEARER_TOKEN_LOCAL_BEARER_AUTH=your_access_token_here

验证配置

配置完成后，可以通过以下方式验证：

1. 检查生成器创建的 index.js 文件（位于 build 目录）
2. 查找 securitySchemes 变量定义
3. 确认其中包含你定义的安全方案
4. 确保环境变量名称与生成器期望的格式匹配

常见问题解决

如果授权头未正确传递，可以检查以下几点：

1. 安全方案名称是否拼写正确
2. 环境变量名称是否符合大写和下划线规则
3. 环境变量是否在运行前正确设置
4. 令牌值是否有效且未过期

最佳实践

1. 在文档中明确记录安全方案名称
2. 使用一致的命名约定
3. 考虑使用 .env 文件管理敏感凭证
4. 定期轮换和更新访问令牌

通过以上步骤，开发者可以确保在使用 OpenAPI-MCP-Generator 时正确配置和传递授权头信息，保障 API 访问的安全性。