{"id":15155514,"url":"https://github.com/apidevtools/swagger-express-middleware","last_synced_at":"2025-09-30T03:31:32.801Z","repository":{"id":28108476,"uuid":"31606965","full_name":"APIDevTools/swagger-express-middleware","owner":"APIDevTools","description":"Swagger 2.0 middlware and mocks for Express.js","archived":true,"fork":false,"pushed_at":"2024-03-06T17:39:14.000Z","size":12825,"stargazers_count":575,"open_issues_count":1,"forks_count":196,"subscribers_count":20,"default_branch":"master","last_synced_at":"2025-09-13T15:21:33.346Z","etag":null,"topics":["expressjs","javascript","middleware","nodejs","openapi","rest-api","server","swagger"],"latest_commit_sha":null,"homepage":"https://apitools.dev/swagger-express-middleware","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/APIDevTools.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-03T15:58:41.000Z","updated_at":"2025-03-09T23:19:30.000Z","dependencies_parsed_at":"2024-03-06T19:17:07.304Z","dependency_job_id":"f35bcea0-0264-487c-bb6a-2f5ac279bfa6","html_url":"https://github.com/APIDevTools/swagger-express-middleware","commit_stats":{"total_commits":309,"total_committers":17,"mean_commits":"18.176470588235293","dds":"0.26860841423948223","last_synced_commit":"fcf54cca0ec4f8c1c8e48c1a4c365b4504e50e7f"},"previous_names":["bigstickcarpet/swagger-express-middleware"],"tags_count":56,"template":false,"template_full_name":null,"purl":"pkg:github/APIDevTools/swagger-express-middleware","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-express-middleware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-express-middleware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-express-middleware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-express-middleware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/APIDevTools","download_url":"https://codeload.github.com/APIDevTools/swagger-express-middleware/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-express-middleware/sbom","scorecard":{"id":7199,"data":{"date":"2025-08-11","repo":{"name":"github.com/APIDevTools/swagger-express-middleware","commit":"fcf54cca0ec4f8c1c8e48c1a4c365b4504e50e7f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.8,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":1,"reason":"Found 2/16 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/CI-CD.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":3,"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"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 16 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"45 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","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-v6h2-p8h4-qcjw","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-fjxv-7rqg-78g4","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-44fp-w29j-9vj5","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-52f5-9888-hmc6","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"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-14T13:48:48.221Z","repository_id":28108476,"created_at":"2025-08-14T13:48:48.221Z","updated_at":"2025-08-14T13:48:48.221Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277626821,"owners_count":25849786,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-30T02:00:09.208Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["expressjs","javascript","middleware","nodejs","openapi","rest-api","server","swagger"],"created_at":"2024-09-26T18:22:51.479Z","updated_at":"2025-09-30T03:31:31.987Z","avatar_url":"https://github.com/APIDevTools.png","language":"JavaScript","readme":"Swagger Express Middleware\n============================\n### Swagger 2.0 middleware and mocks for Express.js\n\n\u003e :warning: **No longer maintained**\n\u003e This package has been abandoned for some time, and there are plenty of modern alternatives around which support OpenAPI v3.x listed on [OpenAPI.Tools](https://openapi.tools/) which you can use instead.\n\n[![npm](https://img.shields.io/npm/v/@apidevtools/swagger-express-middleware.svg)](https://www.npmjs.com/package/@apidevtools/swagger-express-middleware)\n[![License](https://img.shields.io/npm/l/@apidevtools/swagger-express-middleware.svg)](LICENSE)\n[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/APIDevTools/swagger-express-middleware)\n\n\n\nFeatures\n--------------------------\n- **Supports Swagger 2.0 specs in JSON or YAML** \u003cbr\u003e\nSwagger Express Middleware uses [Swagger-Parser](https://github.com/APIDevTools/swagger-parser) to parse, validate, and dereference Swagger files.  You can even split your spec into multiple different files using `$ref` pointers.\n\n- **Thoroughly tested**\u003cbr\u003e\nOver 1,000 unit tests and integration tests with 100% code coverage.  Tested on [**over 1,500 real-world APIs**](https://apis.guru/browse-apis/) from Google, Microsoft, Facebook, Spotify, etc.  All tests are run on Mac, Linux, and Windows using all LTS versions of Node.\n\n- [**Mock middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/mock.html)\u003cbr\u003e\n**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.\n\n- [**Metadata middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/metadata.html)\u003cbr\u003e\nAnnotates 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`.\n\n- [**Parse Request middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/parseRequest.html)\u003cbr\u003e\nParses incoming requests and converts everything into the correct data types, according to your Swagger API definition.\n\n- [**Validate Request middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/validateRequest.html)\u003cbr\u003e\nEnsures 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.\n\n- [**CORS middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/CORS.html)\u003cbr\u003e\nAdds the appropriate CORS headers to each request and automatically responds to CORS preflight requests, all in compliance with your Swagger API definition.\n\n- [**Files middleware**](https://apitools.dev/swagger-express-middleware/docs/middleware/files.html)\u003cbr\u003e\nServes the Swagger API file(s) in JSON or YAML format so they can be used with front-end tools like [Swagger UI](http://www.swagger.io), [Swagger Editor](http://editor.swagger.io), and [Postman](http://getpostman.com).\n\n\n\nInstallation and Use\n--------------------------\nInstall using [npm](https://docs.npmjs.com/about-npm/).\n\n```bash\nnpm install @apidevtools/swagger-express-middleware\n```\nThen use it in your [Node.js](http://nodejs.org/) script like this:\n\n```javascript\nconst express = require('express');\nconst createMiddleware = require('@apidevtools/swagger-express-middleware');\n\nlet app = express();\n\ncreateMiddleware('PetStore.yaml', app, function(err, middleware) {\n    // Add all the Swagger Express Middleware, or just the ones you need.\n    // NOTE: Some of these accept optional options (omitted here for brevity)\n    app.use(\n        middleware.metadata(),\n        middleware.CORS(),\n        middleware.files(),\n        middleware.parseRequest(),\n        middleware.validateRequest(),\n        middleware.mock()\n    );\n\n    app.listen(8000, function() {\n        console.log('The PetStore sample is now running at http://localhost:8000');\n    });\n});\n```\n\n\n\nSamples \u0026 Walkthroughs\n--------------------------\nSwagger Express Middleware comes two samples that use the [Swagger Pet Store API](https://github.com/APIDevTools/swagger-express-middleware/blob/master/samples/PetStore.yaml).\n\n#### Sample 1\nThis 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.\n\n* [Source Code](https://github.com/APIDevTools/swagger-express-middleware/blob/master/samples/sample1.js)\n* [Walkthrough](https://apitools.dev/swagger-express-middleware/docs/walkthroughs/running.html)\n\n\n#### Sample 2\nThis 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.\n\n* [Source Code](https://github.com/APIDevTools/swagger-express-middleware/blob/master/samples/sample2.js)\n* [Walkthrough](https://apitools.dev/swagger-express-middleware/docs/walkthroughs/walkthrough2.html)\n\n\n\nContributing\n--------------------------\nI welcome any contributions, enhancements, and bug-fixes.  [Open an issue](https://github.com/APIDevTools/swagger-express-middleware/issues) on GitHub and [submit a pull request](https://github.com/APIDevTools/swagger-express-middleware/pulls).\n\n#### Building/Testing\nTo build/test the project locally on your computer:\n\n1. **Clone this repo**\u003cbr\u003e\n`git clone https://github.com/APIDevTools/swagger-express-middleware.git`\n\n2. **Install dependencies**\u003cbr\u003e\n`npm install`\n\n3. **Run the tests**\u003cbr\u003e\n`npm test`\n\n4. **Run the sample app**\u003cbr\u003e\n`npm start`\n\n\n\nLicense\n--------------------------\nSwagger Express Middleware is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.\n\nThis package is [Treeware](http://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/APIDevTools/swagger-express-middleware) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.\n\n\n\nBig Thanks To\n--------------------------\nThanks to these awesome companies for their support of Open Source developers ❤\n\n[![Travis CI](https://jstools.dev/img/badges/travis-ci.svg)](https://travis-ci.com)\n[![SauceLabs](https://jstools.dev/img/badges/sauce-labs.svg)](https://saucelabs.com)\n[![Coveralls](https://jstools.dev/img/badges/coveralls.svg)](https://coveralls.io)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapidevtools%2Fswagger-express-middleware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapidevtools%2Fswagger-express-middleware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapidevtools%2Fswagger-express-middleware/lists"}