Express-openapi-validator NPM | npm.io

5.1.6 • Published 2 months ago

Install

Weekly downloads

52,613

License

MIT

Repository

Last release

2 months ago

🦋 express-openapi-validator

docs.

An OpenApi validator for ExpressJS that automatically validates API requests and responses using an OpenAPI 3 specification.

🦋express-openapi-validator is an unopinionated library that integrates with new and existing API applications. express-openapi-validator lets you write code the way you want; it does not impose any coding convention or project layout. Simply, install the validator onto your express app, point it to your OpenAPI 3 specification, then define and implement routes the way you prefer. See an example.

Features:

✔️ request validation
✔️ response validation (json only)
👮 security validation / custom security functions
👽 3rd party / custom formats / custom data serialization-deserialization
🧵 optionally auto-map OpenAPI endpoints to Express handler functions
✂️ \$ref support; split specs over multiple files
🎈 file upload

Docs:

📖 documentation

NestJS Koa and Fastify now available! 🚀

Install

npm install express-openapi-validator

## latest beta
npm install express-openapi-validator@4.14.0-beta.1

Usage

Require/import the openapi validator

const OpenApiValidator = require('express-openapi-validator');

or

import * as OpenApiValidator from 'express-openapi-validator';

Install the middleware

app.use(
  OpenApiValidator.middleware({
    apiSpec: './openapi.yaml',
    validateRequests: true, // (default)
    validateResponses: true, // false by default
  }),
);

Register an error handler

app.use((err, req, res, next) => {
  // format error
  res.status(err.status || 500).json({
    message: err.message,
    errors: err.errors,
  });
});

Important: Ensure express is configured with all relevant body parsers. Body parser middleware functions must be specified prior to any validated routes. See an example.

Documentation

See the doc for complete documenation

deprecated legacy doc

License

openapi openapi 3 expressjs express request validation response validation middleware nodejs

@apidevtools/json-schema-ref-parser @types/multer ajv ajv-draft-04 ajv-formats content-type json-schema-traverse lodash.clonedeep lodash.get media-typer multer ono path-to-regexp

sb-filmotheque openapi-typescript-node-merged-latest1 petrol-tis openapi-typescript-node-sku1 @sbesson/sample-vuejs catalog.seventhbit.io @ipublicweb/ipublicweb-count-api @map-colonies/external-to-osm-tag-mapping @paxsoftware/cores uhc-public-api-nodejs oas3-tools-tugboat @infinitebrahmanuniverse/nolb-express-o thing-it-server updated-oas3-tools @everything-registry/sub-chunk-1634 map-colonies-boilerplate-example @cryptoaddicteds/acn-express-rest-interface felix-oas3-tools febby express-http-server express-openapi-validator-example fastify-openapi-validator forked-agent-protocol export-management @espressotrip-org/product-blue-common @elenaizaguirre/cactus-cmd-api-server @elenaizaguirre/cactus-core @elenaizaguirre/cactus-plugin-ledger-connector-corda @fluidware-it/express-microservice @freight-trust/editoken-api json-id-merger jh-response-object jzanecook-e2b-sdk-test koa-x-oapi-validator koa-openapi-validator yamls-openapi-validator osm-sync-tracker osm-change-generator-server oas3-tools oas3-tools-alejo oas3-tools-cors oas3-tools-middleware-and-cors-fix n8n-test n8n myntra-tushar-petstore nayi-waali-file-mein-krre petstore2 petstore-myntra-tushar-check node-red-contrib-rollun-openapi openbackhaul-oas3-tools nut-ioc-express openapi-typescript-node-bookstore openapi-json-response-validator openapi-helper open-express openapi-angular-material-schematic lesscode-gateway mao-core mediaserve-common modjo qcms-api-test qd-srv-boillerplate pringo-sdk protocol-server_v2 rbc-compliance-api test-nest @backstage/backend-openapi-utils carry-on-node cbrzn-agent-protocol change-merger cactus-plugin-ledger-connector-polkadot swagger-tools-oas3 swagger-endpoint-validator @bajerm/cactus-core cor-base-service simple-mock-services api-server-sim serverless-wrapper-openapi ai-svc rosetta-node-sdk rosetta-sdk-typescript ai-mock-api-generator sample-accekjsdkfjbskf-sdf-oauth2-project torrent-stream-server discrete-overseer-creator directus-extension-api-docs demo-cxc dods-lambda @derech1e/oas3-tools @dhruv-m-patel/rest-api @dhruv-m-patel/express-app @dci-lint/cmd-api-server @jh-tech/response-object @haimkastner/oas3-tools @hasiltech/service-helper @hyperledger/cactus-core @hyperledger/cactus-plugin-ledger-connector-polkadot @hyperledger/cactus-plugin-ledger-connector-corda @hyperledger/cactus-cmd-api-server @node-red-tools/node-red-contrib-openapi

2 months ago

2 months ago

2 months ago

3 months ago

5 months ago

5 months ago

5 months ago

8 months ago

8 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago