OpenAPI-TS 项目中 TanStack Query 生成器命名优化方案

背景介绍

在 OpenAPI-TS 项目中，当开发者使用 TanStack Query 插件生成 API 客户端代码时，会遇到一个常见的命名规范问题：对于 POST 请求的搜索端点，默认会生成一个 mutation 操作，而实际上这类端点更适合作为查询(query)操作使用。

问题本质

在 RESTful API 设计中，虽然 POST 请求通常用于创建资源(mutation)，但有时也会用于复杂查询场景，特别是当查询参数过于复杂无法通过 URL 参数传递时。这种情况下，开发者更希望将这些 POST 端点作为查询(query)而非变更(mutation)来处理。

现有解决方案

当前 OpenAPI-TS 的 TanStack Query 插件已经提供了解决方案：

1. 对于所有端点都会生成一个 xxxOptions 函数
2. 这个函数返回的选项可以直接用于 useQuery 或 useMutation 钩子
3. 开发者可以自由选择将 POST 端点用作查询还是变更

例如：

const query = useQuery({
  ...postLoansOptions({
    body: {
      query: {
        op: 'eq',
        args: { property: 'zipCode', value: '90815' },
      },
    },
  }),
});

改进方向

虽然现有方案功能完整，但从开发者体验角度仍有优化空间：

1. 命名一致性：目前生成的函数统一使用 Options 后缀，而开发者可能期望更明确的 Query 或 Mutation 后缀

2. 可配置性：可以增加配置选项，允许开发者：

   • 自定义生成函数的命名模式
   • 为特定端点强制指定生成查询或变更操作
   • 基于 OpenAPI 文档中的 operationId 或路径模式进行规则匹配

3. 文档增强：更突出地展示如何将 POST 端点用作查询的最佳实践

技术实现建议

要实现更灵活的命名配置，可以考虑以下方案：

// 配置示例
{
  namingConvention: {
    query: {
      pattern: '{operationId}Query', // 或 '{pathName}Query'
      overrides: [
        {
          path: '/search',
          method: 'post',
          type: 'query' // 强制作为查询
        }
      ]
    },
    mutation: {
      pattern: '{operationId}Mutation'
    }
  }
}

最佳实践

对于搜索类 POST 端点，推荐以下处理方式：

1. 语义明确：在 OpenAPI 文档中为搜索类 POST 端点添加明确的 operationId，如 searchUsers

2. 类型安全：利用生成的类型定义确保查询参数和返回值的类型安全

3. 性能优化：对于高频搜索，考虑结合 TanStack Query 的缓存策略优化性能

总结

OpenAPI-TS 项目为 TanStack Query 集成提供了坚实的基础设施，通过合理的配置和命名优化，可以进一步提升开发者体验。未来可以考虑增加更灵活的命名配置选项，同时保持现有功能的向后兼容性。