{"id":14986509,"url":"https://github.com/apidevtools/swagger-parser","last_synced_at":"2026-01-17T07:15:27.781Z","repository":{"id":37484546,"uuid":"25453221","full_name":"APIDevTools/swagger-parser","owner":"APIDevTools","description":"Swagger 2.0 and OpenAPI 3.0 parser/validator","archived":false,"fork":false,"pushed_at":"2025-04-18T19:06:41.000Z","size":42285,"stargazers_count":1136,"open_issues_count":63,"forks_count":161,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-05-12T13:15:44.003Z","etag":null,"topics":["javascript","json-schema","nodejs","openapi","openapi3","parser","resolver","rest-api","swagger","universal-javascript","validation","validator"],"latest_commit_sha":null,"homepage":"http://apidevtools.com/swagger-parser/","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":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"philsturgeon"}},"created_at":"2014-10-20T06:14:51.000Z","updated_at":"2025-05-05T20:28:36.000Z","dependencies_parsed_at":"2024-06-12T15:43:55.852Z","dependency_job_id":"1e7c3b0c-28e6-45e2-ac7a-b5f1f3b95ddc","html_url":"https://github.com/APIDevTools/swagger-parser","commit_stats":{"total_commits":626,"total_committers":33,"mean_commits":18.96969696969697,"dds":"0.15335463258785942","last_synced_commit":"1d9776e2445c3dfc62cf2cd63a33f3449e5ed9fa"},"previous_names":["bigstickcarpet/swagger-parser"],"tags_count":91,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APIDevTools%2Fswagger-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/APIDevTools","download_url":"https://codeload.github.com/APIDevTools/swagger-parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745196,"owners_count":21957319,"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","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":["javascript","json-schema","nodejs","openapi","openapi3","parser","resolver","rest-api","swagger","universal-javascript","validation","validator"],"created_at":"2024-09-24T14:13:03.264Z","updated_at":"2026-01-17T07:15:27.758Z","avatar_url":"https://github.com/APIDevTools.png","language":"JavaScript","readme":"# Swagger 2.0 and OpenAPI 3.0 parser/validator\n\n[![Build Status](https://github.com/APIDevTools/swagger-parser/workflows/CI-CD/badge.svg?branch=master)](https://github.com/APIDevTools/swagger-parser/actions)\n[![Coverage Status](https://coveralls.io/repos/github/APIDevTools/swagger-parser/badge.svg?branch=master)](https://coveralls.io/github/APIDevTools/swagger-parser)\n[![Tested on APIs.guru](https://api.apis.guru/badges/tested_on.svg)](https://apis.guru/browse-apis/)\n\n[![npm](https://img.shields.io/npm/v/@apidevtools/swagger-parser.svg)](https://www.npmjs.com/package/@apidevtools/swagger-parser)\n[![Dependencies](https://david-dm.org/APIDevTools/swagger-parser.svg)](https://david-dm.org/APIDevTools/swagger-parser)\n[![License](https://img.shields.io/npm/l/@apidevtools/swagger-parser.svg)](LICENSE)\n[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://shop.protect.earth/)\n\n[![OS and Browser Compatibility](https://apidevtools.com/img/badges/ci-badges-with-ie.svg)](https://github.com/APIDevTools/swagger-parser/actions)\n\n## Features\n\n- Parses Swagger specs in **JSON** or **YAML** format\n- Validates against the [Swagger 2.0 schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json) or [OpenAPI 3.0 Schema](https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v3.0/schema.json)\n- [Resolves](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#resolveapi-options-callback) all `$ref` pointers, including external files and URLs\n- Can [bundle](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#bundleapi-options-callback) all your Swagger files into a single file that only has _internal_ `$ref` pointers\n- Can [dereference](https://apidevtools.com/swagger-parser/docs/swagger-parser.html#dereferenceapi-options-callback) all `$ref` pointers, giving you a normal JavaScript object that's easy to work with\n- **[Tested](https://github.com/APIDevTools/swagger-parser/actions)** in Node.js and all modern web browsers on Mac, Windows, and Linux\n- Tested on **[over 1,500 real-world APIs](https://apis.guru/browse-apis/)** from Google, Microsoft, Facebook, Spotify, etc.\n- Supports [circular references](https://apidevtools.com/swagger-parser/docs/#circular-refs), nested references, back-references, and cross-references\n- Maintains object reference equality \u0026mdash; `$ref` pointers to the same value always resolve to the same object instance\n\n## Related Projects\n\n- [Swagger CLI](https://github.com/APIDevTools/swagger-cli)\n- [Swagger Express Middleware](https://github.com/APIDevTools/swagger-express-middleware)\n\n## Example\n\n```javascript\nSwaggerParser.validate(myAPI, (err, api) =\u003e {\n  if (err) {\n    console.error(err);\n  } else {\n    console.log(\"API name: %s, Version: %s\", api.info.title, api.info.version);\n  }\n});\n```\n\nOr use `async`/`await` or [Promise](http://javascriptplayground.com/blog/2015/02/promises/) syntax instead. The following example is the same as above:\n\n```javascript\ntry {\n  let api = await SwaggerParser.validate(myAPI);\n  console.log(\"API name: %s, Version: %s\", api.info.title, api.info.version);\n} catch (err) {\n  console.error(err);\n}\n```\n\nFor more detailed examples, please see the [API Documentation](https://apidevtools.com/swagger-parser/docs/)\n\n## Installation\n\nInstall using [npm](https://docs.npmjs.com/about-npm/):\n\n```bash\nnpm install @apidevtools/swagger-parser\n```\n\n## Usage\n\nWhen using Swagger Parser in Node.js apps, you'll probably want to use **CommonJS** syntax:\n\n```javascript\nconst SwaggerParser = require(\"@apidevtools/swagger-parser\");\n```\n\nWhen using a transpiler such as [Babel](https://babeljs.io/) or [TypeScript](https://www.typescriptlang.org/), or a bundler such as [Webpack](https://webpack.js.org/) or [Rollup](https://rollupjs.org/), you can use **ECMAScript modules** syntax instead:\n\n```javascript\nimport * as SwaggerParser from \"@apidevtools/swagger-parser\";\n```\n\n## Browser support\n\nSwagger Parser supports recent versions of every major web browser. Older browsers may require [Babel](https://babeljs.io/) and/or [polyfills](https://babeljs.io/docs/en/next/babel-polyfill).\n\nTo use Swagger Parser in a browser, you'll need to use a bundling tool such as [Webpack](https://webpack.js.org/), [Rollup](https://rollupjs.org/), [Parcel](https://parceljs.org/), or [Browserify](http://browserify.org/). Some bundlers may require a bit of configuration, such as setting `browser: true` in [rollup-plugin-resolve](https://github.com/rollup/rollup-plugin-node-resolve).\n\n## API Documentation\n\nFull API documentation is available [right here](https://apidevtools.com/swagger-parser/docs/)\n\n## Security\n\nThe library, by default, attempts to resolve any files referenced using `$ref`, without considering file extensions or the location of the files. This can result in Local File Inclusion (LFI), thus, potentially sensitive information disclosure. Developers must be cautious when working with documents from untrusted sources. See [here](SECURITY.md) for more details and information on how to mitigate LFI.\n\n## Contributing\n\nI welcome any contributions, enhancements, and bug-fixes. [Open an issue](https://github.com/APIDevTools/swagger-parser/issues) on GitHub and [submit a pull request](https://github.com/APIDevTools/swagger-parser/pulls).\n\nTo test the project locally on your computer:\n\n1. **Clone this repo**\u003cbr\u003e\n   `git clone https://github.com/APIDevTools/swagger-parser.git`\n\n2. **Install dependencies**\u003cbr\u003e\n   `npm install`\n\n3. **Run the tests**\u003cbr\u003e\n   `npm test`\n\n4. **Check the code coverage**\u003cbr\u003e\n   `npm run coverage`\n\n## License\n\nSwagger Parser 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://shop.protect.earth) to thank us for our work.\n\n## Big Thanks To\n\nThanks to these awesome companies for their support of Open Source developers ❤\n\n[![GitHub](https://apidevtools.com/img/badges/github.svg)](https://github.com/open-source)\n[![NPM](https://apidevtools.com/img/badges/npm.svg)](https://www.npmjs.com/)\n[![Coveralls](https://apidevtools.com/img/badges/coveralls.svg)](https://coveralls.io)\n","funding_links":["https://github.com/sponsors/philsturgeon"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapidevtools%2Fswagger-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapidevtools%2Fswagger-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapidevtools%2Fswagger-parser/lists"}