Validate input and output

Nango automatically validates your integration inputs & outputs. It also offers ways to further customize data validation in code. The guide will walk you through each approach.

​

Automatic validation

The validation is available during development and production, and does not require any configuration from you:

• CLI: Dry Run validation errors are logged and will halt execution when using --validation command option
• Production: Validation errors are logged but do not halt execution

​

Available schema files

When you use Nango CLI, it automatically generates two schema files in the .nango folder:

• schema.ts a TypeScript file that contains all your models.
• schema.json a JSON Schema file that is used for automatic data validation.

These files can be versioned and integrated into your own codebase, ensuring consistency and reliability across different environments.

​

Custom Validation

For more advanced use cases, you can generate your own validation schemas using the available files with the tool of your choice.

• Typescript `zod`
• Golang
• Rust

npx ts-to-zod .nango/schema.ts schema.zod.ts

import { myZodModel } from '../../schema.zod.js';

export default async fetchData(nango: Nango) {
  const response = await nango.get({ endpoint: '/tickets' });
  const isValid = myZodModel.parse(response.json);
  if (isValid) {
    [...]
  }
}

​

Using schema.json in your codebase

JSON Schema is supported in most of the main software languages, here is a non-exhaustive list of how you can directly use this file to validate the records you receive from Nango.

• Typescript
• Golang
• Rust
• Python

import { Ajv } from 'ajv';
import addFormats from 'ajv-formats';
import jsonSchema from '.nango/schema.json';

// Initiate AJV
const ajv = new Ajv({ allErrors: true, discriminator: true });
addFormats(ajv);

const modelToValidate = 'MyModelName';
const myData = {"id": "hello-word"};

// Compile the JSON schema
const validate = ajv.compile({
  ...jsonSchema,
  ...jsonSchema['definitions'][modelToValidate]
});

// Validate your data
validate(mydata);