npmpackage.info

Gathering detailed insights and metrics for swagger-express-middleware

Other packages similar to swagger-express-middleware

@apidevtools/swagger-express-middleware

4.0.2

Swagger middleware and mocks for Express

@types/swagger-express-middleware

1.0.16

TypeScript definitions for swagger-express-middleware

swagger-express-mw

0.7.0

Swagger loader and middleware for express

redoc-express

2.1.0

Express Middleware for OpenAPI/Swagger-generated API Reference Documentation

Gathering detailed insights and metrics for swagger-express-middleware

swagger-express-middleware

Swagger 2.0 middlware and mocks for Express.js

4.0.2

573

MIT

JavaScript

549.08 kB

14,446,127 2.8

Installations

npm install swagger-express-middleware

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

10.22.0

NPM Version

6.14.6 Score

29.6

Supply Chain

80.5

Quality

77.3

Maintenance

Vulnerability

98.9

License

Pull Requests

Open

0

Total

52

Closed

35

Merged

17

Issues

Open

1

Total

134

Closed

133

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 15 contributors

Languages

JavaScript

JavaScript (100%)

Developer

APIDevTools

Download Statistics

Total Downloads

14,446,127

Last Day

1,283

Last Week

6,765

Last Month

41,094

Last Year

497,237

GitHub Statistics

573 Stars

335 Commits

199 Forks

21 Watching

3 Branches

15 Contributors

Bundle Size

1.56 MB

Minified

549.08 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

4.0.2

Package Id

swagger-express-middleware@4.0.2

Size

4.94 kB

NPM Version

6.14.6

Node Version

10.22.0

Publised On

01 Aug 2020

Total Downloads

Cumulative downloads

Total Downloads

14,446,127

Last day

-1.9%

1,283

Compared to previous day

Last week

-14.5%

6,765

Compared to previous week

Last month

-16.3%

41,094

Compared to previous month

Last year

37.8%

497,237

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/swagger-express-middleware

Versions

Swagger Express Middleware

Swagger 2.0 middleware and mocks for Express.js

Features

Supports Swagger 2.0 specs in JSON or YAML
Swagger Express Middleware uses Swagger-Parser to parse, validate, and dereference Swagger files. You can even split your spec into multiple different files using $ref pointers.
Thoroughly tested
Over 1,000 unit tests and integration tests with 100% code coverage. Tested on over 1,500 real-world APIs from Google, Microsoft, Facebook, Spotify, etc. All tests are run on Mac, Linux, and Windows using all LTS versions of Node.
Mock middleware
Fully-functional mock implementations for every operation in your API, including data persistence, all with zero code! This is a great way to test-drive your API as you write it, or for quick demos and POCs. You can even extend the mock middleware with your own logic and data to fill in any gaps.
Metadata middleware
Annotates each request with all the relevant information from the Swagger definition. The path, the operation, the parameters, the security requirements - they're all easily accessible at req.swagger.
Parse Request middleware
Parses incoming requests and converts everything into the correct data types, according to your Swagger API definition.
Validate Request middleware
Ensures that every request complies with your Swagger API definition, or returns the appropriate HTTP error codes if needed. Of course, you can catch any validation errors and handle them however you want.
CORS middleware
Adds the appropriate CORS headers to each request and automatically responds to CORS preflight requests, all in compliance with your Swagger API definition.
Files middleware
Serves the Swagger API file(s) in JSON or YAML format so they can be used with front-end tools like Swagger UI, Swagger Editor, and Postman.

Installation and Use

Install using npm.

1npm install @apidevtools/swagger-express-middleware

Then use it in your Node.js script like this:

1const express = require('express');
2const createMiddleware = require('@apidevtools/swagger-express-middleware');
3
4let app = express();
5
6createMiddleware('PetStore.yaml', app, function(err, middleware) {
7    // Add all the Swagger Express Middleware, or just the ones you need.
8    // NOTE: Some of these accept optional options (omitted here for brevity)
9    app.use(
10        middleware.metadata(),
11        middleware.CORS(),
12        middleware.files(),
13        middleware.parseRequest(),
14        middleware.validateRequest(),
15        middleware.mock()
16    );
17
18    app.listen(8000, function() {
19        console.log('The PetStore sample is now running at http://localhost:8000');
20    });
21});

Samples & Walkthroughs

Swagger Express Middleware comes two samples that use the Swagger Pet Store API.

Sample 1

This sample demonstrates the most simplistic usage of Swagger Express Middleware. It simply creates a new Express Application and adds all of the Swagger middleware without changing any options, and without adding any custom middleware.

Sample 2

This sample demonstrates a few more advanced features of Swagger Express Middleware, such as setting a few options, initializing the mock data store, and adding custom middleware logic.

Contributing

I welcome any contributions, enhancements, and bug-fixes. Open an issue on GitHub and submit a pull request.

Building/Testing

To build/test the project locally on your computer:

Clone this repo
git clone https://github.com/APIDevTools/swagger-express-middleware.git
Install dependencies
npm install
Run the tests
npm test
Run the sample app
npm start

License

Swagger Express Middleware is 100% free and open-source, under the MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/CI-CD.yaml:100: update your workflow using https://app.stepsecurity.io/secureworkflow/APIDevTools/swagger-express-middleware/CI-CD.yaml/master?enable=pin
Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 2 out of 2 npmCommand dependencies pinned

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

40 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-h452-7996-h45h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-wm7h-9275-46v2
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-qgmg-gppg-76g5
Warn: Project is vulnerable to: GHSA-xx4c-jj58-r7x6
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

2.8

/10

Last Scanned on 2024-12-23

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