Introduction to Fluent Schema

Fluent Schema is an elegant and intuitive JavaScript library that simplifies schema definition and validation for your applications. With its fluent API, defining schemas becomes more readable and maintainable.

The Basics

Fluent Schema allows you to create schemas effortlessly with fluent syntax. Let’s start with a basic example:

  const S = require('fluent-json-schema')
  const schema = S.object()
    .prop('name', S.string().required())
    .prop('age', S.integer())
    .prop('email', S.string().format(S.FORMATS.EMAIL))

Advanced Properties

Fluent Schema includes support for more advanced properties and types:

  const schema = S.object()
    .prop('id', S.string().format(S.FORMATS.UUID).required())
    .prop('tags', S.array().items(S.string()))
    .prop('meta', S.object()
      .prop('createdAt', S.string().format(S.FORMATS.DATE_TIME))
      .prop('updatedAt', S.string().format(S.FORMATS.DATE_TIME)))

Reusable Schemas

You can create reusable schemas to avoid repetition:

  const userSchema = S.object()
    .prop('name', S.string().required())
    .prop('email', S.string().format(S.FORMATS.EMAIL).required())

  const productSchema = S.object()
    .prop('id', S.string().format(S.FORMATS.UUID).required())
    .prop('name', S.string().required())
    .prop('price', S.number().exclusiveMinimum(0))

  const orderSchema = S.object()
    .prop('user', userSchema.required())
    .prop('products', S.array().items(productSchema).minItems(1))

Complete Application Example

Here is a small application example using Express.js and Fluent Schema to validate request data:

  const express = require('express')
  const S = require('fluent-json-schema')
  const app = express()

  app.use(express.json())

  const userSchema = S.object()
      .prop('name', S.string().required())
      .prop('email', S.string().format(S.FORMATS.EMAIL).required())

  app.post('/users', (req, res) => {
    const { error, value } = userSchema.validate(req.body)
    if (error) {
      return res.status(400).send(error.message)
    }
    res.status(201).send('User created successfully!')
  })

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

Conclusion

Fluent Schema makes it effortless to define and validate data schemas in your JavaScript applications. With its fluent API, you can create readable, maintainable, and reusable schemas with ease.

For more details, visit the official Fluent Schema documentation.

Hash: d5c6670bb4d318cacd9185ee6b2d4fb580ce3209f3bacedd342592ba6fb77e86