3.0.22 • Published 7 days ago
@asyncapi/openapi-schema-parser v3.0.22
OpenAPI Schema Parser
An AsyncAPI schema parser for OpenAPI 3.0.x and Swagger 2.x schemas.
Note Version >=
3.0.0
of package is only supported by@asyncapi/parser
version >=2.0.0
.
Installation
npm install @asyncapi/openapi-schema-parser
// OR
yarn add @asyncapi/openapi-schema-parser
Usage
import { Parser } from '@asyncapi/parser';
import { OpenAPISchemaParser } from '@asyncapi/openapi-schema-parser';
const parser = new Parser();
parser.registerSchemaParser(OpenAPISchemaParser());
const asyncapiWithOpenAPI = `
asyncapi: 2.0.0
info:
title: Example with OpenAPI
version: 0.1.0
channels:
example:
publish:
message:
schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'
payload: # The following is an OpenAPI schema
type: object
properties:
title:
type: string
nullable: true
author:
type: string
example: Jack Johnson
`;
const { document } = await parser.parse(asyncapiWithOpenAPI);
const { Parser } = require('@asyncapi/parser');
const { OpenAPISchemaParser } = require('@asyncapi/openapi-schema-parser');
const parser = new Parser();
parser.registerSchemaParser(OpenAPISchemaParser());
const asyncapiWithOpenAPI = `
asyncapi: 2.0.0
info:
title: Example with OpenAPI
version: 0.1.0
channels:
example:
publish:
message:
schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'
payload: # The following is an OpenAPI schema
type: object
properties:
title:
type: string
nullable: true
author:
type: string
example: Jack Johnson
`;
const { document } = await parser.parse(asyncapiWithOpenAPI);
It also supports referencing remote OpenAPI schemas:
import { Parser } from '@asyncapi/parser';
import { OpenAPISchemaParser } from '@asyncapi/openapi-schema-parser';
const parser = new Parser();
parser.registerSchemaParser(OpenAPISchemaParser());
const asyncapiWithOpenAPI = `
asyncapi: 2.0.0
info:
title: Example with OpenAPI
version: 0.1.0
channels:
example:
publish:
message:
schemaFormat: 'application/vnd.oai.openapi;version=3.0.0'
payload:
$ref: 'yourserver.com/schemas#/Book'
`;
const { document } = await parser.parse(asyncapiWithOpenAPI);
3.0.22
7 days ago
3.0.21
10 days ago
3.0.20
22 days ago
3.0.19
25 days ago
3.0.18
1 month ago
3.0.16
1 month ago
3.0.17
1 month ago
3.0.15
2 months ago
3.0.14
2 months ago
3.0.13
3 months ago
3.0.12
3 months ago
3.0.11
3 months ago
3.0.10
4 months ago
3.0.9
4 months ago
3.0.8
5 months ago
3.0.7
5 months ago
3.0.6
5 months ago
3.0.4
9 months ago
3.0.5
6 months ago
3.0.3
11 months ago
3.0.2
11 months ago
3.0.1
11 months ago
3.0.0
12 months ago
2.0.3
1 year ago
2.0.2
1 year ago
2.0.1
3 years ago
2.0.0
4 years ago
1.1.0
4 years ago
1.0.0
4 years ago
0.2.0
4 years ago