在ts-rest中使用@anatine/zod-openapi增强OpenAPI文档

ts-rest是一个强大的TypeScript API契约定义工具，它允许开发者使用Zod模式来定义API契约。结合@anatine/zod-openapi库，我们可以为这些Zod模式添加丰富的OpenAPI元数据，从而生成更详细、更专业的API文档。

为什么需要OpenAPI扩展

在标准的ts-rest使用中，我们使用Zod来定义API的请求和响应模式。虽然这已经能生成基本的OpenAPI文档，但有时我们需要为文档添加更多细节，比如：

• 字段的描述信息
• 示例值
• 标题和更详细的说明
• 其他OpenAPI特有的元数据

这正是@anatine/zod-openapi发挥作用的地方。它扩展了Zod，允许我们为每个字段和整个模式添加OpenAPI特定的元数据。

如何使用扩展功能

首先需要初始化扩展环境：

import { z } from 'zod';
import { extendZodWithOpenApi } from '@anatine/zod-openapi';

// 扩展Zod以支持OpenAPI
extendZodWithOpenApi(z);

然后就可以在定义API契约时使用.openapi()方法来添加元数据：

import { initContract } from '@ts-rest/core';

const c = initContract();

export const contract = c.router({
  getUser: {
    method: 'GET',
    path: '/users/:id',
    pathParams: z.object({
      id: z.string(),
    }),
    responses: {
      200: z
        .object({
          id: z.string().uuid().openapi({
            title: 'Unique ID',
            description: 'A UUID generated by the server',
          }),
          name: z.string(),
          phoneNumber: z.string().min(10).openapi({
            description: 'US phone numbers only',
            example: '555-555-5555',
          }),
        })
        .openapi({
          title: 'User',
          description: 'A user schema',
        }),
    },
  },
});

元数据类型详解

.openapi()方法可以接受多种OpenAPI元数据：

1. 字段级元数据：

   • title：字段的标题
   • description：字段的详细描述
   • example：字段的示例值
   • format：字段的格式（如date-time, uuid等）

2. 模式级元数据：

   • 对整个对象模式添加标题和描述
   • 定义外部文档链接
   • 添加其他OpenAPI规范支持的元数据

最佳实践

1. 为关键字段添加描述：特别是那些有特殊格式要求或业务含义的字段。

2. 提供示例值：这能帮助API使用者更好地理解如何使用你的API。

3. 保持一致性：在整个API中保持相似的文档风格和详细程度。

4. 不要过度文档化：只为真正需要解释的部分添加元数据，避免文档过于冗长。

通过这种方式，ts-rest生成的OpenAPI文档将更加专业和实用，极大地提升API的可理解性和易用性。