在TsED项目中使用@Examples()装饰器增强Swagger文档

概述

TsED框架提供了强大的装饰器功能来增强API文档的生成。其中@Examples()装饰器是一个非常实用的工具，它允许开发者为API参数或模型属性定义多个示例值，从而在Swagger UI中生成直观的下拉选择框。

问题背景

在TsED项目中，开发者经常需要为API参数提供示例值。当参数直接定义在控制器方法中时，可以使用@Examples()装饰器轻松实现这一需求。但随着项目规模扩大，开发者倾向于将参数封装到模型类中，这时就遇到了@Examples()装饰器无法直接在模型属性上使用的问题。

解决方案

TsED 7.66.0版本对此进行了优化，现在可以在模型类上使用@Examples()装饰器。以下是具体实现方式：

基本用法

class QueryParamModel {
  @Property()
  path: string;

  @Property()
  condition: string;

  @Property()
  value: string;
}

@Path("/query")
class QueryModelCtrl {
  @OperationPath("GET", "/")
  async get(
    @QueryParams()
    @Examples({
      example1: {
        description: "description1",
        value: {
          path: "path1",
          condition: "condition1"
        }
      },
      example2: {
        description: "description1",
        value: {
          path: "path2",
          condition: "condition2"
        }
      }
    })
    q: QueryParamModel
  ) {}
}

生成效果

上述代码会生成包含示例值的Swagger文档，每个属性都会显示对应的示例选项：

{
  "paths": {
    "/query": {
      "get": {
        "parameters": [
          {
            "in": "query",
            "name": "path",
            "examples": {
              "example1": {
                "description": "description1",
                "value": "path1"
              },
              "example2": {
                "description": "description1",
                "value": "path2"
              }
            },
            "schema": {
              "type": "string"
            }
          },
          {
            "examples": {
              "example1": {
                "description": "description1",
                "value": "condition1"
              },
              "example2": {
                "description": "description1",
                "value": "condition2"
              }
            },
            "in": "query",
            "name": "condition",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  }
}

技术细节

1. 装饰器位置：@Examples()装饰器应放在模型类作为参数使用的装饰器之后，如@QueryParams()之后。

2. 示例结构：示例对象需要遵循特定格式，包含description和value属性，value值应与模型结构匹配。

3. 自动映射：框架会自动将模型级别的示例值映射到各个属性上，无需为每个属性单独定义示例。

4. Swagger UI效果：生成的文档会在Swagger UI中为每个参数显示下拉选择框，方便API使用者快速选择预定义的示例值。

最佳实践

1. 语义化示例名称：为每个示例使用有意义的名称，方便识别。

2. 完整描述：为每个示例提供清晰的description，说明使用场景。

3. 覆盖典型场景：提供足够多的示例覆盖常见使用场景。

4. 保持一致性：确保示例值与实际业务逻辑一致，避免误导API使用者。

总结

TsED框架通过增强@Examples()装饰器的功能，使开发者能够更灵活地为模型类定义示例值，大大提升了API文档的可用性和开发体验。这一改进特别适合大型项目中使用模型类封装参数的场景，既保持了代码的整洁性，又提供了丰富的文档支持。