Class-validator-jsonschema 项目常见问题解决方案-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00110/article/details/145180715

Class-validator-jsonschema 项目常见问题解决方案

class-validator-jsonschema Convert class-validator-decorated classes into JSON schema 项目地址: https://gitcode.com/gh_mirrors/cl/class-validator-jsonschema

项目基础介绍

class-validator-jsonschema 是一个开源项目，它可以将使用 class-validator 装饰器修饰的类转换为 OpenAPI 兼容的 JSON Schema。该项目的目标是提供一个尽可能准确的转换，但由于某些 class-validator 装饰器在 JSON Schema 中没有直接的对应，转换过程可能带有一定的主观性。该项目主要使用 TypeScript 编程语言开发。

新手常见问题与解决方案

问题一：如何安装 `class-validator-jsonschema`？

问题描述： 新手在使用项目时，不知道如何安装 class-validator-jsonschema。

解决步骤：

打开命令行工具（例如：终端或命令提示符）。
切换到你的项目目录。
运行以下命令安装 class-validator-jsonschema：
```
npm install class-validator-jsonschema
```
如果遇到版本兼容性问题，可以尝试安装之前的版本。

问题二：如何使用 `class-validator-jsonschema` 转换类为 JSON Schema？

问题描述： 新手不知道如何使用 class-validator-jsonschema 将类转换为 JSON Schema。

解决步骤：

首先，确保已经安装了 class-validator 和 class-validator-jsonschema。

在你的 TypeScript 文件中，引入 class-validator 的相关装饰器和 class-validator-jsonschema 的转换函数：

import { IsString, IsOptional, MaxLength } from 'class-validator';
import { validationMetadatasToSchemas } from 'class-validator-jsonschema';

定义一个类，并使用 class-validator 装饰器修饰：

class BlogPost {
  @IsString()
  id: string;

  @IsOptional()
  @MaxLength(20, { each: true })
  tags: string[];
}

调用 validationMetadatasToSchemas 函数来转换类为 JSON Schema：

const schemas = validationMetadatasToSchemas();
console.log(schemas);

问题三：如何为 `class-validator-jsonschema` 转换结果添加自定义描述？

问题描述： 新手想要为转换后的 JSON Schema 添加自定义描述，但不知道如何操作。

解决步骤：

引入 ValidationTypes 以及需要的装饰器。

在调用 validationMetadatasToSchemas 函数时，通过 additionalConverters 选项添加自定义转换器：

import { ValidationTypes } from 'class-validator';

const schemas = validationMetadatasToSchemas([
  {
    additionalConverters: [
      [ValidationTypes.IS_STRING, { description: 'A string value', type: 'string' }],
    ],
  },
]);