ts-rest项目中Swagger UI重复显示子路由问题的分析与解决

问题背景

在使用ts-rest框架构建API时，开发者经常会遇到需要将多个契约(contract)组合成一个单一契约的情况。这种模块化的设计模式虽然提高了代码的可维护性，但在生成Swagger UI文档时却可能导致路由重复显示的问题。

问题现象

当开发者将已经组合的契约再次作为子契约组合到更大的契约中时，Swagger UI会将这些子契约的路由显示两次。例如，一个auth契约下包含otp子契约，在Swagger UI中otp相关的路由会同时出现在auth和otp两个标签下。

问题根源

这个问题的根本原因在于OpenAPI规范本身不支持嵌套标签。当ts-rest框架生成OpenAPI文档时，每个路由会被标记上所有层级的契约标签。例如，otp子契约下的路由会被同时标记auth和otp两个标签，而Swagger UI会为每个标签单独显示这些路由，导致重复显示。

解决方案

要解决这个问题，我们需要对生成的OpenAPI文档进行后处理，限制每个路由只保留最具体的标签（即最后一个标签）。以下是具体的实现方案：

import { generateOpenApi } from '@ts-rest/open-api';
import type {
  PathsObject,
  OperationObject,
} from '@nestjs/swagger/dist/interfaces/open-api-spec.interface';

// 类型守卫函数，判断是否为操作对象
function isOperationObject(value: unknown): value is OperationObject {
  return typeof value === 'object' && value !== null && 'tags' in value;
}

// 生成原始OpenAPI文档
const document = generateOpenApi(api, config);

// 处理文档中的路径对象
document.paths = Object.entries(document.paths).reduce<PathsObject>(
  (paths, [path, definition]) => {
    paths[path] = Object.entries(definition).reduce<Record<string, unknown>>(
      (newDefinition, [key, value]) => {
        if (isOperationObject(value)) {
          // 限制每个操作只保留第一个标签
          newDefinition[key] = { ...value, tags: value.tags?.slice(0, 1) };
        } else {
          newDefinition[key] = value;
        }
        return newDefinition;
      },
      {},
    );
    return paths;
  },
  {},
);

实现原理

1. 类型检查：使用isOperationObject类型守卫确保我们只处理包含操作定义的对象。

2. 路径处理：遍历文档中的所有路径定义，对每个路径下的操作进行处理。

3. 标签限制：对于每个操作对象，我们保留其标签数组中的第一个元素，这样就能确保路由只出现在最直接的父契约标签下。

4. 不变性保持：使用展开运算符...确保我们在修改标签时不会意外改变操作对象的其他属性。

最佳实践建议

1. 契约组织：在设计API契约结构时，尽量避免过深的嵌套层级，这不仅能避免Swagger UI的显示问题，也能提高代码的可读性。

2. 文档定制：考虑将OpenAPI文档的后处理逻辑封装成可复用的工具函数，方便在多个项目中共享。

3. 标签策略：如果业务确实需要多标签显示，可以考虑实现更复杂的标签处理逻辑，如基于特定规则保留或排除某些标签。

总结

通过理解OpenAPI规范的限制和ts-rest框架的实现机制，我们能够有效地解决Swagger UI中路由重复显示的问题。这种解决方案不仅保持了API契约的模块化设计优势，还能生成清晰、易读的API文档，为开发者提供更好的开发体验。