class-validator-jsonschema 项目教程

1. 项目的目录结构及介绍

class-validator-jsonschema/
├── src/
│   ├── index.ts
│   ├── decorators/
│   │   ├── IsDateString.ts
│   │   ├── IsEnum.ts
│   │   └── ...
│   ├── utils/
│   │   ├── validationMetadatasToSchemas.ts
│   │   └── ...
│   └── ...
├── test/
│   ├── index.spec.ts
│   ├── decorators/
│   │   ├── IsDateString.spec.ts
│   │   ├── IsEnum.spec.ts
│   │   └── ...
│   └── ...
├── package.json
├── tsconfig.json
└── README.md

目录结构说明

• src/：项目的主要源代码目录。
  • index.ts：项目的入口文件。
  • decorators/：包含各种装饰器文件，如 IsDateString.ts 和 IsEnum.ts。
  • utils/：包含各种工具函数，如 validationMetadatasToSchemas.ts。
• test/：项目的测试代码目录。
  • index.spec.ts：入口文件的测试。
  • decorators/：装饰器的测试文件。
• package.json：项目的依赖管理文件。
• tsconfig.json：TypeScript 配置文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

入口文件 src/index.ts

import 'reflect-metadata';
import { validationMetadatasToSchemas } from './utils/validationMetadatasToSchemas';
import { getMetadataStorage } from 'class-validator';

export { validationMetadatasToSchemas };

// 其他导出内容...

文件说明

• import 'reflect-metadata';：引入 reflect-metadata 库，用于元数据的反射。
• import { validationMetadatasToSchemas } from './utils/validationMetadatasToSchemas';：引入工具函数 validationMetadatasToSchemas，用于将验证元数据转换为 JSON Schema。
• export { validationMetadatasToSchemas };：导出 validationMetadatasToSchemas 函数，供外部使用。

3. 项目的配置文件介绍

package.json

{
  "name": "class-validator-jsonschema",
  "version": "5.0.1",
  "description": "Convert class-validator decorated classes into JSON schema",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "class-validator": "^0.13.1",
    "reflect-metadata": "^0.1.13"
  },
  "devDependencies": {
    "@types/jest": "^27.0.1",
    "jest": "^27.0.6",
    "ts-jest": "^27.0.3",
    "typescript": "^4.4.3"
  }
}

文件说明

• name：项目名称。
• version：项目版本。
• description：项目描述。
• main：项目的主入口文件。
• types：TypeScript 类型定义文件。
• scripts：包含项目的构建和测试脚本。
• dependencies：项目的依赖库，如 class-validator 和 reflect-metadata。
• devDependencies：开发依赖库，如 jest 和 typescript。

tsconfig.json

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "declaration": true
  },
  "include": ["src