Security News
Fluent Assertions Faces Backlash After Abandoning Open Source Licensing
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
@swagger-api/apidom-parser-adapter-openapi-json-3-1
Advanced tools
Parser adapter for parsing JSON documents into OpenAPI 3.1.x namespace.
@swagger-api/apidom-parser-adapter-openapi-json-3-1 is an npm package designed to parse and adapt OpenAPI 3.1 JSON documents. It is part of the ApiDOM ecosystem, which provides tools for working with API descriptions in various formats.
Parsing OpenAPI 3.1 JSON Documents
This feature allows you to parse OpenAPI 3.1 JSON documents into a structured format that can be easily manipulated and analyzed.
const { parse } = require('@swagger-api/apidom-parser-adapter-openapi-json-3-1');
const openApiJson = '{ "openapi": "3.1.0", "info": { "title": "Sample API", "version": "1.0.0" }, "paths": {} }';
parse(openApiJson).then((parsed) => {
console.log(parsed);
}).catch((error) => {
console.error(error);
});
Validating OpenAPI 3.1 JSON Documents
This feature allows you to validate OpenAPI 3.1 JSON documents to ensure they conform to the OpenAPI 3.1 specification.
const { validate } = require('@swagger-api/apidom-parser-adapter-openapi-json-3-1');
const openApiJson = '{ "openapi": "3.1.0", "info": { "title": "Sample API", "version": "1.0.0" }, "paths": {} }';
validate(openApiJson).then((result) => {
if (result.valid) {
console.log('The document is valid.');
} else {
console.log('The document is invalid:', result.errors);
}
}).catch((error) => {
console.error(error);
});
swagger-parser is a powerful tool for parsing, validating, and dereferencing Swagger and OpenAPI definitions. It supports OpenAPI 3.0 and 2.0, but does not yet support OpenAPI 3.1. It provides similar functionalities such as parsing and validation but is more focused on earlier versions of the OpenAPI specification.
openapi-schema-validator is a package specifically designed for validating OpenAPI 3.0 and 3.1 schemas. While it focuses solely on validation, it provides robust error reporting and is highly configurable. It does not offer parsing capabilities like @swagger-api/apidom-parser-adapter-openapi-json-3-1.
swagger-client is a JavaScript client for Swagger and OpenAPI specifications. It allows you to parse, validate, and interact with API definitions. While it supports OpenAPI 3.0, its primary focus is on providing a client interface for interacting with APIs rather than just parsing and validating the specifications.
@swagger-api/apidom-parser-adapter-openapi-json-3-1
is a parser adapter for the OpenAPI 3.1.0 specification in JSON format.
Under the hood this adapter uses apidom-parser-adapter-json
to parse a source string into generic ApiDOM in base ApiDOM namespace
which is then refracted with OpenAPI 3.1.0 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-openapi-json-3-1
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.oai.openapi;version=3.1.0',
'application/vnd.oai.openapi+json;version=3.1.0',
]
Detection is based on a regular expression matching required OpenAPI 3.1.0 specification symbols in JSON format.
This adapter exposes an instance of OpenAPI 3.1.0 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 OpenAPI 3.1.0 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-openapi-json-3-1';
// detecting
await detect('{"openapi": "3.1.0"}'); // => true
await detect('test'); // => false
// parsing
const parseResult = await parse('{"openapi": "3.1.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 openApiJsonAdapter from '@swagger-api/apidom-parser-adapter-openapi-json-3-1';
const parser = new ApiDOMParser();
parser.use(openApiJsonAdapter);
const parseResult = await parser.parse('{"openapi": "3.1.0"}', { mediaType: openApiJsonAdapter.mediaTypes.latest('json') });
1.0.0-beta.6 (2024-12-30)
FAQs
Parser adapter for parsing JSON documents into OpenAPI 3.1.x namespace.
The npm package @swagger-api/apidom-parser-adapter-openapi-json-3-1 receives a total of 482,278 weekly downloads. As such, @swagger-api/apidom-parser-adapter-openapi-json-3-1 popularity was classified as popular.
We found that @swagger-api/apidom-parser-adapter-openapi-json-3-1 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.