Validation

Novel makes use of 2 validation mechanisms: JSON Schema and Zod. both serve specific purpose, for shaping requests and responses and for verifying input.

Although these are optional, it is recommended that you build your system utilizing these tools as much as possible.

API Specs and Database

JSON Schema, used within fastify via AJV, makes it easy to enforce how your api should behave before, during, and after processing.

This, along with the fast performance brought by fastify, makes your system more resilient when dealing with APIs.

You can see the libraries below

Ajv JSON schema validator

JSON SchemaJSON Schema

The standards above makes it easier to generate clients via OpenAPI/Swagger. These definitions are generated and used internally by the Novel Web client to easily expose routes as an RPC and provide an easy development experience.

JSON Schema is recommended to be used for API Request/Response shapes. Client-side validation should use zod instead.

Using Validations →

Securing an Endpoint →

For client-side validation. refer to Validation.

Changelog

• 2024-12-20 - Initial Documentation