Gathering detailed insights and metrics for express-openapi-validator
Gathering detailed insights and metrics for express-openapi-validator
🦋 Auto-validates api requests, responses, and securities using ExpressJS and an OpenAPI 3.x specification
Installations
npm install express-openapi-validatorDeveloper
cdimascio
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
20.12.2
NPM Version
10.7.0
Statistics
920 Stars
1,962 Commits
211 Forks
19 Watching
30 Branches
102 Contributors
Updated on 20 Nov 2024
Languages
TypeScript (99.38%)
JavaScript (0.6%)
Shell (0.02%)
Total Downloads
Cumulative downloads
Total Downloads
30,212,614
Last day
3.7%
51,846
Compared to previous day
Last week
3.5%
265,907
Compared to previous week
Last month
7.2%
1,123,274
Compared to previous month
Last year
27.3%
11,265,187
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
13
Peer Dependencies
1
Versions
🦋 express-openapi-validator
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:
NestJS Koa and Fastify now available! 🚀
Install
1npm install express-openapi-validator 2 3# experimental OAS 3.1 in alpha (contributions welcome - see branch `oas-3.1` and pr-882 4# please provide feedback on (issue-573) 5npm install express-openapi-validator@6.0.0-alpha.5
Usage
- Require/import the openapi validator
1const OpenApiValidator = require('express-openapi-validator');
or
1import * as OpenApiValidator from 'express-openapi-validator';
- Install the middleware
1app.use( 2 OpenApiValidator.middleware({ 3 apiSpec: './openapi.yaml', 4 validateRequests: true, // (default) 5 validateResponses: true, // false by default 6 }), 7);
- Register an error handler
1app.use((err, req, res, next) => { 2 // format error 3 res.status(err.status || 500).json({ 4 message: err.message, 5 errors: err.errors, 6 }); 7});
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
No vulnerabilities found.
Reason
30 commit(s) and 9 issue activity found in the last 90 days -- score normalized to 10
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Info: topLevel 'contents' permission set to 'read': .github/workflows/default.yml:6
- Info: no jobLevel write permissions found
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Warn: no linked content found
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/default.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/cdimascio/express-openapi-validator/default.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/default.yml:15
- Info: 0 out of 1 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 2 npmCommand dependencies pinned
Reason
Found 4/26 approved changesets -- score normalized to 1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 20 are checked with a SAST tool
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Score
5.4
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More