# swagger-express-validator-formats

> swagger-express-validator, but with more supported Swagger formats passed to AJV

Latest version **0.0.6** (published 2017-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install swagger-express-validator-formats
pnpm add swagger-express-validator-formats
yarn add swagger-express-validator-formats
bun add swagger-express-validator-formats
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2017-10-27 |
| First published | 2017-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6.0.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nazar Gargol |
| Maintainers | jasonavery |
| Keywords | validation, swagger, middleware, connect, express |

## Links

- npm: https://www.npmjs.com/package/swagger-express-validator-formats
- Repository: https://github.com/jsonsonson/swagger-express-validator
- Homepage: https://github.com/jsonsonson/swagger-express-validator#readme
- Issues: https://github.com/jsonsonson/swagger-express-validator/issues
- npm.io page: https://npm.io/package/swagger-express-validator-formats

## Dependencies (5)

- [ajv](https://npm.io/package/ajv.md) ^4.10.3
- [debug](https://npm.io/package/debug.md) ^2.6.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.3
- [validator](https://npm.io/package/validator.md) ^6.2.1
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^1.7.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.6 (latest) — 2017-10-27
- 0.0.5 — 2017-10-26
- 0.0.4 — 2017-10-26
- 0.0.3 — 2017-10-26
- 0.0.2 — 2017-10-26
- 0.0.1 — 2017-10-26

## README

Swagger Express Validator
=========================

Forked off of https://github.com/gargol/swagger-express-validator  
Supported version of this fork will now be @jsonsonson/swagger-express-validator

[![Build Status](https://travis-ci.org/gargol/swagger-express-validator.svg?branch=master)](https://travis-ci.org/gargol/swagger-express-validator)

`swagger-express-validator` is a lightweight middleware for request/response validation based on
[OpenAPI v2.0](http://swagger.io/specification/) (aka swagger) specification.

The main difference of this package to alternatives like
[swagger-tools](https://github.com/apigee-127/swagger-tools) is that this package is very
configurable and only concentrates on validation against provided schema. You can choose the
behavior of invalid validation like returning a 500 or just logging an error to your logger.

## Requirements
- express ^4.0.0
- body-parser ^1.0.0

## Features
* Configurable validation behavior
* [Fastest](https://github.com/ebdrup/json-schema-benchmark) available JSON schema validation based on [ajv](https://github.com/epoberezkin/ajv) library
* Optional validations for either request parameters or response values
* Independent from express application structure. This is a simple drop-in middleware without additional
 alterations to your swagger definitions or application routing.
* Support for nullable field validation though `x-nullable` attribute

## Installation
Start using this library with `npm install swagger-express-validator --save`

## Sample use
To set up simple validation for your requests and responses:
```javascript
const util = require('util');
const express = require('express');
const bodyParser = require('body-parser');
const validator = require('swagger-express-validator');
const schema = require('./api-schema.json');

const server = express();
server.use(bodyParser.json());

const opts = {
  schema,
  validateRequest: true,
  validateResponse: true,
  nonExistentProperties: true,
  requestValidationFn: (req, data, errors) => {
    console.log(`failed request validation: ${req.method} ${req.originalUrl}\n ${util.inspect(errors)}`)
  },
  responseValidationFn: (req, data, errors) => {
    console.log(`failed response validation: ${req.method} ${req.originalUrl}\n ${util.inspect(errors)}`)
  },
};
server.use(validator(opts));

server.use('/status', (req, res) => {
  res.json({
    status: 'OK',
  })
});
server.use((err, req, res, next) => {
  res.status(500);
  res.json(err);
});

return server.listen(3000);

```

## Debugging
To see debug output use `DEBUG=swagger-express-validator` as an environmental varialbe when starting
your project, eg.: `DEBUG=swagger-express-validator node server.js`. To gain more insights
on how this works see documentation of [debug](https://github.com/visionmedia/debug) library

## Contributors
- [Nazar Gargol](https://github.com/gargol)
- [Isaac Stefanek](https://github.com/iadknet)

## Licence
[MIT](https://github.com/gargol/swagger-express-validator/blob/master/LICENSE)

Special thanks to @bgaluszka for initial inspiration :)

---
_Source: https://npm.io/package/swagger-express-validator-formats · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._