# openapi-schema-validator

> A validator for OpenAPI documents.

Latest version **12.1.3** (published 2023-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install openapi-schema-validator
pnpm add openapi-schema-validator
yarn add openapi-schema-validator
bun add openapi-schema-validator
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 12.1.3 |
| Published | 2023-05-24 |
| First published | 2018-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 106.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 921 |
| Author | Joseph Spencer |
| Maintainers | jsdevel |
| Keywords | openapi, schema, validator |

## Links

- npm: https://www.npmjs.com/package/openapi-schema-validator
- Repository: https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator
- Homepage: https://github.com/kogosoftwarellc/open-api/tree/master/packages/openapi-schema-validator#readme
- Issues: https://github.com/kogosoftwarellc/open-api/issues
- npm.io page: https://npm.io/package/openapi-schema-validator

## Dependencies (4)

- [ajv](https://npm.io/package/ajv.md) ^8.1.0
- [ajv-formats](https://npm.io/package/ajv-formats.md) ^2.0.2
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1
- [openapi-types](https://npm.io/package/openapi-types.md) ^12.1.3

## Alternatives

- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads

## Recent versions

- 12.1.3 (latest) — 2023-05-24
- 12.1.2 — 2023-05-24
- 12.1.1 — 2023-05-20
- 12.1.0 — 2022-12-09
- 12.0.2 — 2022-08-31
- 12.0.0 — 2022-06-03
- 11.1.0 — 2022-06-03
- 11.0.1 — 2022-05-16
- 11.0.0 — 2022-04-13
- 10.0.0 — 2021-12-02
- 9.3.1 — 2021-11-12
- 9.3.0 — 2021-08-30
- 9.2.0 — 2021-08-20
- 9.1.0 — 2021-07-06
- 9.0.3 — 2021-06-01
- … 13 more at https://npm.io/package/openapi-schema-validator/versions

## README

# openapi-schema-validator [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Coveralls Status][coveralls-image]][coveralls-url]
> A validator for OpenAPI documents.

## Supported OpenAPI versions

* `v3`
* `v2` (formerly known as Swagger V2)

## Document examples and full specs:
* [Official 2.0 docs](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#itemsObject)
* [Official 3.0.0 docs](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md)

## Highlights

* Validate openapi documents against openapi schema documents.
* Uses [jsonschema](https://github.com/tdegrunt/jsonschema) under the hood.
* Performant.
* Currently supports type definitions included in the `definitions` property of the
provided openapi document.
* Extensively tested.
* Small footprint.

**Huge thank you to the [gnostic](https://github.com/googleapis/gnostic) project for building up a 3.0.0 JSON schema.**


## Example
```javascript
var OpenAPISchemaValidator = require('openapi-schema-validator').default;
var validator = new OpenAPISchemaValidator({
  version: 2,
  // optional
  extensions: {
    /* place any properties here to extend the schema. */
  }
});
console.log(validator.validate(apiDoc));
```

* `version` _number_ openapi document schema version to use (2 or 3).
    * 2 - `openapi-2.0.0` (default)
    * 3 - `openapi-3.0.0`

[see here](https://github.com/tdegrunt/jsonschema#results) for example results.


## API
### .validate(apiDoc)
* `apiDoc` _object_ is any api document you wish to validate.


## LICENSE
``````
The MIT License (MIT)

Copyright (c) 2018 Kogo Software LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
``````

[downloads-image]: http://img.shields.io/npm/dm/openapi-schema-validator.svg
[npm-url]: https://npmjs.org/package/openapi-schema-validator
[npm-image]: http://img.shields.io/npm/v/openapi-schema-validator.svg

[coveralls-url]: https://coveralls.io/github/kogosoftwarellc/open-api?branch=main
[coveralls-image]: https://coveralls.io/repos/github/kogosoftwarellc/open-api/badge.svg?branch=main

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