https://github.com/tinacious/express-joi-validate

⛔️ Simple route validation middleware for Express using Joi 🚥
https://github.com/tinacious/express-joi-validate

express expressjs joi nodejs typescript validation

Last synced: 2 months ago
JSON representation

⛔️ Simple route validation middleware for Express using Joi 🚥

• Host: GitHub
• URL: https://github.com/tinacious/express-joi-validate
• Owner: tinacious
• License: mit
• Created: 2017-06-03T19:59:34.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T20:15:44.000Z (about 2 years ago)
• Last Synced: 2024-04-14T23:07:36.332Z (10 months ago)
• Topics: express, expressjs, joi, nodejs, typescript, validation
• Language: JavaScript
• Homepage:
• Size: 192 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Route validation for Express using Joi

![](https://travis-ci.org/tinacious/express-joi-validate.svg?branch=master)

[![codecov](https://codecov.io/gh/tinacious/express-joi-validate/branch/master/graph/badge.svg)](https://codecov.io/gh/tinacious/express-joi-validate)

This custom middleware is for those who prefer to use Express but want to use the Joi validation library to validate the query, params, and body of requests.

## Usage

Install with NPM:

```

npm install express-joi-validate --save

```

Or with Yarn:

```

yarn add express-joi-validate

```

Without route validation, an endpoint may look something like this:

```js

app.get('/contacts/:id', contactsHandler);

```

To implement route validation, simply call the provided validation function with the desired schema that uses Joi:

```js

const Joi = require('@hapi/joi');

const validate = require('express-joi-validate');

const contactSchema = {

  params: {

    id: Joi.number().required()

  }

};

app.get('/contacts/:id', validate(contactSchema), contactsHandler);

```

In TypeScript, it would look like this:

```typescript

import Joi, { SchemaMap } from '@hapi/joi';

import validate from 'express-joi-validate';

const contactSchema: SchemaMap = {

  params: {

    id: Joi.number().required()

  }

};

app.get('/contacts/:id', validate(contactSchema), contactsHandler);

```

Note: for the above, the type `SchemaMap` is inferred and not required.

For more information about this library, see the blog post [Express route param validation (Node.js)](https://tinaciousdesign.com/blog/express-route-param-validation-nodejs).

## Development

### Testing

Test the 3 different types of validations using the tests and mock server:

```

npm test

```

### TypeScript

Generate TypeScript definitions:

```

npm run tsc

```