\n\n[๐ฆexpress-openapi-validator](https://github.com/cdimascio/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.0.x** or **3.1.x** specification, then define and implement routes the way you prefer. See an [example](https://cdimascio.github.io/express-openapi-validator-documentation/guide-standard/).\n\n**Features:**\n\n- โ๏ธ request validation\n- โ๏ธ response validation (json only)\n- ๐ฎ security validation / custom security functions\n- ๐ฝ 3rd party / custom formats / custom data serialization-deserialization\n- ๐งต optionally auto-map OpenAPI endpoints to Express handler functions\n- โ๏ธ **\\$ref** support; split specs over multiple files\n- ๐ file upload\n- โ๏ธ OpenAPI 3.0.x and 3.1.x spec support\n- โจ Express 4 and 5 support\n\n\n\n**Docs:**\n- ๐ [documentation](https://cdimascio.github.io/express-openapi-validator-documentation/)\n\n[](https://GitHub.com/cdimascio/express-openapi-validator/stargazers/) [](https://twitter.com/intent/tweet?text=Check%20out%20express-openapi-validator%20by%20%40CarmineDiMascio%20https%3A%2F%2Fgithub.com%2Fcdimascio%2Fexpress-openapi-validator%20%F0%9F%91%8D)\n\n[Express 5](https://expressjs.com/en/5x/api.html) support available in `>=v5.5.0`!\n\n[OAS 3.1](https://github.com/cdimascio/express-openapi-validator/pull/882) support available in `>=v5.4.0`!\n\n[NestJS](https://github.com/cdimascio/express-openapi-validator/tree/master/examples/9-nestjs)\n[Koa](https://github.com/cdimascio/express-openapi-validator/tree/lerna-fastify/packages/koa-openapi-validator) and [Fastify](https://github.com/cdimascio/express-openapi-validator/tree/lerna-fastify/packages/fastify-openapi-validator) now available! ๐\n\n\n## Install\n\n```shell\nnpm install express-openapi-validator\n```\n\n## Usage\n\n1. Require/import the openapi validator\n\n```javascript\nconst OpenApiValidator = require('express-openapi-validator');\n```\n\nor\n\n```javascript\nimport * as OpenApiValidator from 'express-openapi-validator';\n```\n\n2. Install the middleware\n\n```javascript\napp.use(\n OpenApiValidator.middleware({\n apiSpec: './openapi.yaml',\n validateRequests: true, // (default)\n validateResponses: true, // false by default\n }),\n);\n```\n\n3. Register an error handler\n\n```javascript\napp.use((err, req, res, next) => {\n // format error\n res.status(err.status || 500).json({\n message: err.message,\n errors: err.errors,\n });\n});\n```\n\n_**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](#example-express-api-server)_.\n\n## [Documentation](https://cdimascio.github.io/express-openapi-validator-documentation/)\n\nSee the [doc](https://cdimascio.github.io/express-openapi-validator-documentation/) for complete documenation\n\n_deprecated_ [legacy doc](https://github.com/cdimascio/express-openapi-validator/wiki) \n\n## License\n\n[MIT](LICENSE)\n\n","users":{}}
![](\"https://raw.githubusercontent.com/cdimascio/express-openapi-validator/master/assets/express-openapi-validator-logo-v2.png\"){kind=logo}
\n![\"Buy](\"https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png\")
","users":{}}