{"id":13880913,"url":"https://github.com/asyncapi/openapi-schema-parser","last_synced_at":"2025-08-16T05:31:51.501Z","repository":{"id":37907891,"uuid":"246628307","full_name":"asyncapi/openapi-schema-parser","owner":"asyncapi","description":"An AsyncAPI schema parser for OpenAPI 3.0.x and Swagger 2.x schemas.","archived":false,"fork":false,"pushed_at":"2024-06-12T12:48:57.000Z","size":2051,"stargazers_count":13,"open_issues_count":0,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-29T22:38:04.565Z","etag":null,"topics":["get-global-node-release-workflows","get-global-releaserc","nodejs","openapi","parser"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asyncapi.png","metadata":{"funding":{"github":"asyncapi","patreon":null,"open_collective":"asyncapi","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null},"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-11T16:50:55.000Z","updated_at":"2024-10-24T09:17:08.000Z","dependencies_parsed_at":"2023-02-16T09:45:32.197Z","dependency_job_id":"d11b75eb-0ccb-44b2-94c7-6c8ab1fceb68","html_url":"https://github.com/asyncapi/openapi-schema-parser","commit_stats":{"total_commits":243,"total_committers":10,"mean_commits":24.3,"dds":0.2222222222222222,"last_synced_commit":"1dfa803503b3b94faeac413dc95b5b98726c153d"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fopenapi-schema-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fopenapi-schema-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fopenapi-schema-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asyncapi%2Fopenapi-schema-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asyncapi","download_url":"https://codeload.github.com/asyncapi/openapi-schema-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230013035,"owners_count":18159603,"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":["get-global-node-release-workflows","get-global-releaserc","nodejs","openapi","parser"],"created_at":"2024-08-06T08:03:38.797Z","updated_at":"2024-12-16T19:15:06.285Z","avatar_url":"https://github.com/asyncapi.png","language":"TypeScript","funding_links":["https://github.com/sponsors/asyncapi","https://opencollective.com/asyncapi"],"categories":["TypeScript"],"sub_categories":[],"readme":"# OpenAPI Schema Parser\n\nAn AsyncAPI schema parser for OpenAPI 3.0.x and Swagger 2.x schemas.\n\n\u003e **Note**\n\u003e Version \u003e= `3.0.0` of package is only supported by `@asyncapi/parser` version \u003e= `2.0.0`.\n\n\u003c!-- toc is generated with GitHub Actions do not remove toc markers --\u003e\n\n\u003c!-- toc --\u003e\n\n- [Installation](#installation)\n- [Usage](#usage)\n\n\u003c!-- tocstop --\u003e\n\n## Installation\n\n```bash\nnpm install @asyncapi/openapi-schema-parser\n// OR\nyarn add @asyncapi/openapi-schema-parser\n```\n\n## Usage\n\n```ts\nimport { Parser } from '@asyncapi/parser';\nimport { OpenAPISchemaParser } from '@asyncapi/openapi-schema-parser';\n\nconst parser = new Parser();\nparser.registerSchemaParser(OpenAPISchemaParser()); \n\nconst asyncapiWithOpenAPI = `\nasyncapi: 2.0.0\ninfo:\n  title: Example with OpenAPI\n  version: 0.1.0\nchannels:\n  example:\n    publish:\n      message:\n        schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'\n        payload: # The following is an OpenAPI schema\n          type: object\n          properties:\n            title:\n              type: string\n              nullable: true\n            author:\n              type: string\n              example: Jack Johnson\n`;\n\nconst { document } = await parser.parse(asyncapiWithOpenAPI);\n```\n\n```js\nconst { Parser } = require('@asyncapi/parser');\nconst { OpenAPISchemaParser } = require('@asyncapi/openapi-schema-parser');\n\nconst parser = new Parser();\nparser.registerSchemaParser(OpenAPISchemaParser()); \n\nconst asyncapiWithOpenAPI = `\nasyncapi: 2.0.0\ninfo:\n  title: Example with OpenAPI\n  version: 0.1.0\nchannels:\n  example:\n    publish:\n      message:\n        schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'\n        payload: # The following is an OpenAPI schema\n          type: object\n          properties:\n            title:\n              type: string\n              nullable: true\n            author:\n              type: string\n              example: Jack Johnson\n`;\n\nconst { document } = await parser.parse(asyncapiWithOpenAPI);\n```\n\nIt also supports referencing remote OpenAPI schemas:\n\n```ts\nimport { Parser } from '@asyncapi/parser';\nimport { OpenAPISchemaParser } from '@asyncapi/openapi-schema-parser';\n\nconst parser = new Parser();\nparser.registerSchemaParser(OpenAPISchemaParser()); \n\nconst asyncapiWithOpenAPI = `\nasyncapi: 2.0.0\ninfo:\n  title: Example with OpenAPI\n  version: 0.1.0\nchannels:\n  example:\n    publish:\n      message:\n        schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'\n        payload:\n          $ref: 'yourserver.com/schemas#/Book'\n`;\n\nconst { document } = await parser.parse(asyncapiWithOpenAPI);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasyncapi%2Fopenapi-schema-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasyncapi%2Fopenapi-schema-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasyncapi%2Fopenapi-schema-parser/lists"}