Welcome to Alpha Validator: The Ultimate Tool for API Validation

Alpha Validator is a powerful library designed to ensure that your API requests and responses adhere to the defined schemas. It’s a crucial tool for developers who want to maintain the integrity and reliability of their applications.

Getting Started with Alpha Validator

To begin using Alpha Validator, you need to install it via npm:

  
  npm install alpha-validator
  

Basic Validation Example

Here’s a simple example to help you understand how Alpha Validator operates:

  
  const { validate, Schema } = require('alpha-validator');

  const userSchema = new Schema({
    name: { type: 'string', required: true },
    email: { type: 'string', pattern: 'email' },
    age: { type: 'number', min: 18 }
  });

  const userData = {
    name: "John Doe",
    email: "john.doe@example.com",
    age: 25
  };

  const validationResult = validate(userSchema, userData);
  if (validationResult.valid) {
    console.log("User data is valid");
  } else {
    console.error("Validation errors:", validationResult.errors);
  }
  

Advanced API Examples

Array Validation

  
  const arraySchema = new Schema({
    tags: { type: 'array', items: { type: 'string' }, minItems: 1 }
  });

  const data = { tags: ['nodejs', 'api'] };

  const result = validate(arraySchema, data);
  console.log(result.valid); // true
  

Nested Object Validation

  
  const addressSchema = new Schema({
    street: { type: 'string', required: true },
    city: { type: 'string', required: true }
  });

  const userSchema = new Schema({
    name: { type: 'string', required: true },
    address: { type: 'object', schema: addressSchema, required: true }
  });

  const userData = {
    name: "Jane Doe",
    address: { street: "123 Main St", city: "Somewhere" }
  };

  const result = validate(userSchema, userData);
  console.log(result.valid); // true
  

Custom Error Messages

  
  const schema = new Schema({
    username: { type: 'string', min: 6, message: 'Username should be at least 6 characters long' }
  });

  const data = { username: 'abc' };

  const result = validate(schema, data);
  if (!result.valid) {
    console.error(result.errors); // ['Username should be at least 6 characters long']
  }
  

Application Example

Below is a practical example of how Alpha Validator can be integrated into an Express.js application:

  
  const express = require('express');
  const { validate, Schema } = require('alpha-validator');
  
  const app = express();
  app.use(express.json());
  
  const userSchema = new Schema({
    name: { type: 'string', required: true },
    email: { type: 'string', pattern: 'email' },
    age: { type: 'number', min: 18 }
  });

  app.post('/user', (req, res) => {
    const validationResult = validate(userSchema, req.body);
    if (!validationResult.valid) {
      return res.status(400).json({ errors: validationResult.errors });
    }
    // process the valid data
    res.status(200).send('User is valid');
  });

  app.listen(3000, () => {
    console.log('Server is running on port 3000');
  });
  

With the help of Alpha Validator, you can ensure that all your API endpoints are robust and secure, helping you to catch and handle errors efficiently.

Happy validating with Alpha Validator!

Hash: 19578ff0da90761917d59b23d4cb5eefc69de26938dd6683960d207366353bfc