如何在hapi-swagger中实现JSON输出的美化打印？

哈哈，这个问题我之前折腾过好一会儿！刚好有两个靠谱的解决方案，帮你让swagger网页端自动美化JSON响应，又不影响API本身的紧凑输出：

方案1：通过hapi-swagger配置直接开启swagger-ui的格式化功能 #

hapi-swagger底层依赖swagger-ui，我们可以通过配置swaggerUI参数，开启它的语法高亮和JSON格式化功能。在注册插件的时候加上这些配置就行：

await server.register({
  plugin: require('hapi-swagger'),
  options: {
    info: {
      title: '你的API文档标题',
      version: '1.0.0'
    },
    swaggerUI: {
      // 开启语法高亮和JSON格式化
      syntaxHighlight: {
        activated: true,
        theme: 'monokai' // 可选，换个你喜欢的高亮主题
      },
      docExpansion: 'list', // 可选，控制文档展开方式
      defaultModelRendering: 'example' // 可选，让模型默认显示示例
    }
  }
});

这个方法最省心，配置完之后swagger-ui会自动把返回的紧凑JSON拆分成带缩进的美观格式，完全不用改动API的核心逻辑。

方案2：通过hapi的响应拦截器针对性美化 #

如果上面的配置不生效（比如你的hapi-swagger版本比较旧），可以用hapi的扩展点来做针对性处理：只对来自swagger-ui的请求返回美化后的JSON，正常API调用依然保持紧凑格式。

添加一个onPreResponse的扩展函数：

server.ext('onPreResponse', (request, h) => {
  const response = request.response;
  // 判断请求是否来自swagger-ui（通过referer或user-agent识别）
  const isSwaggerDebugRequest = request.headers.referer?.includes('/docs') || 
                                request.headers['user-agent']?.includes('Swagger');

  // 只处理正常的JSON响应，跳过错误响应
  if (isSwaggerDebugRequest && !response.isBoom && typeof response.source === 'object') {
    // 把JSON对象转成带缩进的字符串
    response.source = JSON.stringify(response.source, null, 2);
    // 确保Content-Type正确
    response.headers['content-type'] = 'application/json';
  }

  return h.continue;
});

这个方法更灵活，能精准控制哪些请求需要美化，完全不会影响API对外的正常输出格式。

我个人优先推荐方案1，毕竟是官方支持的配置方式，升级hapi-swagger到最新版的话，大概率直接配置就能生效~

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