如何通过Swagger生成可返回本地/随机二进制文件的Node.js桩服务器

Swagger Codegen 官方提供的 Node.js 服务端生成模板，默认仅实现基础的接口路由框架，不会自动解析 OpenAPI 定义中的 externalValue、二进制示例配置，也不会主动拉取远程资源或读取本地文件返回，你之前调整的均为接口描述层配置，不影响桩服务的实际返回逻辑。

方案1：修改生成后的桩服务代码（优先推荐） #

生成服务代码后，找到 controllers 目录下和接口 operationId 匹配的处理文件，直接改写返回逻辑即可：

• 返回本地文件示例：

const fs = require('fs');
const path = require('path');

// 对应你配置的operationId: getImage
exports.getImage = function(req, res) {
  // 替换为你本地文件的实际存储路径
  const localImagePath = path.join(__dirname, '../assets/test.png');
  res.setHeader('Content-Type', 'image/png');
  res.sendFile(localImagePath, (err) => {
    if (err) res.status(400).send('Invalid value');
  });
}

• 返回随机生成图片示例：
  先安装依赖 npm install canvas，再修改处理逻辑：

const { createCanvas } = require('canvas');

exports.getImage = function(req, res) {
  // 生成200*200的随机色值图片
  const canvas = createCanvas(200, 200);
  const ctx = canvas.getContext('2d');
  ctx.fillStyle = `#${Math.floor(Math.random() * 16777215).toString(16)}`;
  ctx.fillRect(0, 0, 200, 200);
  ctx.fillStyle = '#ffffff';
  ctx.font = '22px serif';
  ctx.fillText('Stub Image', 40, 110);

  res.setHeader('Content-Type', 'image/png');
  canvas.createPNGStream().pipe(res);
}

方案2：自定义生成模板（适合频繁重新生成桩服务的场景） #

如果需要多次生成桩服务不想每次手动改代码，可以提取官方 Node.js 服务端模板，修改 controller 生成逻辑：增加对响应 schema 为 type: file 类型的判断，自动注入读取本地指定目录下对应文件的逻辑，后续生成代码时指定自定义模板即可。

方案3：临时测试替代方案 #

如果只是需要快速验证接口联通性，不需要返回真实二进制文件，可以把接口返回 schema 改为 type: string、format: base64，在 example 字段填入任意图片的 base64 编码，桩服务会默认返回该字符串，前端可直接解码渲染为图片。

内容的提问来源于stack exchange，提问作者Andrew