Exa AI Security Scanner

🚀 Ajv

Ajvは、高速なJSON Schemaバリデータで、Draft7とDraft6標準をサポートしています。極めて高速にバリデーションサービスを提供し、以下の特徴を備えています。

🚀 クイックスタート

Ajvは、JSON Schemaのバリデーションを高速かつ効率的に行うことができるツールです。以下に基本的な使い方を説明します。

✨ 主な機能

• コアバリデーション：JSON Schema標準に厳密に準拠しています。
• エラーレポート：詳細なエラー情報を提供し、デバッグを容易にします。
• パフォーマンス最適化：高度に最適化されており、極めて高速です。
• 非同期機能：非同期のキーワードと条件式をサポートします。
• バリデータプラグイン：バリデータシステムを拡張できます。

📦 インストール

npmを使ってAjvをインストールできます。

npm install ajv

💻 使用例

基本的な使用法

const Ajv = require('ajv');
const ajv = new Ajv();
const schema = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'integer', minimum: 0 }
  }
};
const data = { name: "张三", age: 25 };
const validate = ajv.compile(schema);
const { valid, errors } = validate(data);
console.log(valid); // true

高度な使用法

AjvをExpressのミドルウェアとして使用する例です。

app.use(ajv.jsonSchema());

📚 ドキュメント

JSON Schema サポート

Ajvは以下の特性をサポートしています。

• if、then、else キーワード。
• allOf、anyOf、oneOf、not バリデーション。
• const、enum、multipleOf 制約。
• dependencies、dependentRequired 依存関係の処理。
• パスと原因を含む詳細なエラーレポートを提供します。

コントリビューションガイド

すべてのバリデーション関数は、doT テンプレートを使って生成されます。テンプレートは事前にコンパイルされているため、doTはランタイム依存として必要ありません。

ビルド

npm run build

ウォッチ

dot フォルダ内のファイルが変更されると、watch コマンドが自動的にテンプレートをコンパイルします。

npm run watch

詳細については、コントリビューションガイド を参照してください。

変更履歴

バージョン 5.0.1-beta

• 新しいバリデーションエンジンを導入し、パフォーマンスが大幅に向上しました。
• Draft7のサポートを追加しました。

バージョン 4.6.0

• エラーレポートの詳細性を向上させました。
• いくつかの既知の問題を修正しました。

バージョン 3.0.0

• 全面的なアップグレードを行い、新機能と最適化を導入しました。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細は LICENSE を参照してください。