@swagger-api/apidom-parser-adapter-asyncapi-json-2
Advanced tools
Parser adapter for parsing JSON documents into AsyncAPI 2.x.y namespace.
@swagger-api/apidom-parser-adapter-asyncapi-json-2 is a parser adapter for following AsyncAPI specification versions defined in JSON format:
Under the hood this adapter uses @swagger-api/apidom-parser-adapter-json to parse a source string into generic ApiDOM in base ApiDOM namespace which is then refracted with AsyncApi 2.x.y Refractors.
After prerequisites for installing this package are satisfied, you can install it via npm CLI by running the following command:
$ npm install @swagger-api/apidom-parser-adapter-asyncapi-json-2
This parser adapter is fully compatible with parser adapter interface required by @swagger-api/apidom-parser and implements all required properties.
Defines list of media types that this parser adapter recognizes.
[
'application/vnd.aai.asyncapi;version=2.0.0',
'application/vnd.aai.asyncapi;version=2.1.0',
'application/vnd.aai.asyncapi;version=2.2.0',
'application/vnd.aai.asyncapi;version=2.3.0',
'application/vnd.aai.asyncapi;version=2.4.0',
'application/vnd.aai.asyncapi;version=2.5.0',
'application/vnd.aai.asyncapi;version=2.6.0',
'application/vnd.aai.asyncapi+json;version=2.0.0',
'application/vnd.aai.asyncapi+json;version=2.1.0',
'application/vnd.aai.asyncapi+json;version=2.2.0',
'application/vnd.aai.asyncapi+json;version=2.3.0',
'application/vnd.aai.asyncapi+json;version=2.4.0',
'application/vnd.aai.asyncapi+json;version=2.5.0',
'application/vnd.aai.asyncapi+json;version=2.6.0',
]
Detection is based on a regular expression matching required AsyncApi 2.6.0 specification symbols in JSON format.
This adapter exposes an instance of AsyncApi 2.x.y ApiDOM namespace.
parse function consumes various options as a second argument. Here is a list of these options:
| Option | Type | Default | Description |
|---|---|---|---|
specObj | Object | Specification Object | This specification object drives the JSON AST transformation to AsyncAPI 2.x ApiDOM namespace. |
sourceMap | Boolean | false | Indicate whether to generate source maps. |
refractorOpts | Object | {} | Refractor options are passed to refractors during refracting phase. |
All unrecognized arbitrary options will be ignored.
This parser adapter can be used directly or indirectly via @swagger-api/apidom-parser.
During direct usage you don't need to provide mediaType as the parse function is already pre-bound
with supported media types.
import { parse, detect } from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
// detecting
await detect('{"asyncapi": "2.0.0"}'); // => true
await detect('{"asyncapi": "2.1.0"}'); // => true
await detect('{"asyncapi": "2.2.0"}'); // => true
await detect('{"asyncapi": "2.3.0"}'); // => true
await detect('{"asyncapi": "2.4.0"}'); // => true
await detect('{"asyncapi": "2.5.0"}'); // => true
await detect('{"asyncapi": "2.6.0"}'); // => true
await detect('test'); // => false
// parsing
const parseResult = await parse('{"asyncapi": "2.6.0"}', { sourceMap: true });
You can omit the mediaType option here, but please read Word on detect vs mediaTypes before you do so.
import ApiDOMParser from '@swagger-api/apidom-parser';
import * as asyncApiJsonAdapter from '@swagger-api/apidom-parser-adapter-asyncapi-json-2';
const parser = new ApiDOMParser();
parser.use(asyncApiJsonAdapter);
const parseResult = await parser.parse('{"asyncapi": "2.6.0"}', { mediaType: asyncApiJsonAdapter.mediaTypes.latest('json') });
1.0.0-beta.6 (2024-12-30)
FAQs
Parser adapter for parsing JSON documents into AsyncAPI 2.x.y namespace.
We found that @swagger-api/apidom-parser-adapter-asyncapi-json-2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.