Swagger UI 中如何直接加载 YAML 格式的 API 规范字符串

在 API 开发和管理过程中，Swagger UI 是一个非常实用的工具，它可以将 API 规范以可视化界面的形式展示出来。然而，在实际应用中，我们有时会遇到一些特殊情况，比如 API 规范不是通过标准的 URL 提供，而是以字符串形式返回的情况。

问题背景

在某些企业环境中，API 规范可能不会直接暴露为可访问的 URL 端点。例如，某些产品可能将 API 规范打包成 ZIP 文件提供下载，或者通过中间件应用以 JSON 格式返回，其中包含一个 YAML 格式的字符串字段。这种情况下，开发者需要找到一种方法，将这些字符串形式的规范加载到 Swagger UI 中。

解决方案

Swagger UI 的 SwaggerUIBundle 构造函数支持通过 spec 参数直接传入 API 规范对象。这意味着我们可以先将 YAML 字符串转换为 JavaScript 对象，然后再传递给 Swagger UI。

具体实现步骤如下：

1. 首先需要获取包含 YAML 规范字符串的 JSON 响应
2. 使用 YAML 解析库（如 js-yaml）将字符串转换为 JavaScript 对象
3. 将这个对象传递给 Swagger UI 的 spec 配置项

实现示例

以下是一个完整的实现示例：

// 假设这是从中间件获取的响应
const apiResponse = {
  "assetId": "123e4567-e89b-12d3-a456-426614174000",
  "assetName": "示例API",
  "specification": "openapi: 3.0.0\ninfo:\n  title: 示例API\n  version: 1.0.0"
};

// 使用YAML解析库
const yaml = require('js-yaml');

// 将YAML字符串转换为对象
const specObject = yaml.load(apiResponse.specification);

// 初始化Swagger UI
const ui = SwaggerUIBundle({
  spec: specObject,  // 直接传入解析后的对象
  dom_id: '#swagger-ui',
  presets: [
    SwaggerUIBundle.presets.apis,
    SwaggerUIStandalonePreset
  ],
  layout: "StandaloneLayout"
});

注意事项

1. 确保使用的 YAML 解析库能够正确处理 API 规范中的所有语法
2. 转换后的对象应该符合 OpenAPI/Swagger 规范的结构
3. 如果规范中包含引用（$ref），需要确保这些引用能够正确解析
4. 在生产环境中，建议添加错误处理逻辑，以防 YAML 格式不正确导致解析失败

扩展思考

这种方法不仅适用于从中间件获取的 YAML 字符串，还可以应用于以下场景：

• 从本地文件读取的 API 规范
• 通过 WebSocket 或其他非 HTTP 协议接收的规范
• 存储在数据库中的 API 规范定义
• 通过用户输入动态生成的规范

通过这种方式，开发者可以更灵活地将各种来源的 API 规范集成到 Swagger UI 中，而不受限于传统的 URL 访问方式。