Security News
Maven Central Adds Sigstore Signature Validation
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.
@apidevtools/openapi-schemas
Advanced tools
JSON Schemas for every version of the OpenAPI Specification
The @apidevtools/openapi-schemas package provides JSON Schema definitions for OpenAPI Specification (OAS) documents. This allows developers to validate their OpenAPI documents against the official OpenAPI schemas, ensuring they adhere to the correct format and standards set by the OpenAPI Initiative.
Validation of OpenAPI documents
This code sample demonstrates how to use the @apidevtools/openapi-schemas package to validate an OpenAPI 3.0 document using the AJV library, which is a popular JSON schema validator.
const Ajv = require('ajv');
const openApiSchema = require('@apidevtools/openapi-schemas');
const ajv = new Ajv();
const validate = ajv.compile(openApiSchema.v3_0);
const openApiDoc = {
openapi: '3.0.0',
info: {
title: 'Sample API',
version: '1.0'
},
paths: {}
};
const valid = validate(openApiDoc);
if (!valid) console.log(validate.errors);
Swagger Parser is a package that can parse, validate, and dereference Swagger and OpenAPI documents. Unlike @apidevtools/openapi-schemas, which provides JSON schemas for validation, Swagger Parser offers a more comprehensive solution for handling OpenAPI documents including resolving references and can handle both Swagger 2.0 and OpenAPI 3.0 specifications.
OpenAPI Validator is another package that validates OpenAPI documents against the OpenAPI Specification. It provides more detailed validation errors and can also validate request and response data in real time, which is not a direct feature of @apidevtools/openapi-schemas. This package is more focused on API runtime validation whereas @apidevtools/openapi-schemas is primarily used for static schema validation.
This package contains the official JSON Schemas for every version of Swagger/OpenAPI Specification:
Version | Schema | Docs |
---|---|---|
Swagger 1.2 | v1.2 schema | v1.2 docs |
Swagger 2.0 | v2.0 schema | v2.0 docs |
OpenAPI 3.0.x | v3.0.x schema | v3.0.3 docs |
OpenAPI 3.1.x | v3.1.x schema | v3.1.0 docs |
All schemas are kept up-to-date with the latest official definitions via an automated CI/CD job. 🤖📦
You can install OpenAPI Schemas via npm.
npm install @apidevtools/openapi-schemas
The default export contains all OpenAPI Specification versions:
const openapi = require("@apidevtools/openapi-schemas");
console.log(openapi.v1); // { $schema, id, properties, definitions, ... }
console.log(openapi.v2); // { $schema, id, properties, definitions, ... }
console.log(openapi.v3); // { $schema, id, properties, definitions, ... }
console.log(openapi.v31); // { $schema, id, properties, definitions, ... }
Or you can import the specific version(s) that you need:
const { openapiV1, openapiV2, openapiV3, openapiV31 } = require("@apidevtools/openapi-schemas");
console.log(openapiV1); // { $schema, id, properties, definitions, ... }
console.log(openapiV2); // { $schema, id, properties, definitions, ... }
console.log(openapiV3); // { $schema, id, properties, definitions, ... }
console.log(openapiV31); // { $schema, id, properties, definitions, ... }
You can use a JSON Schema validator such as Z-Schema or AJV to validate OpenAPI definitions against the specification.
const { openapiV31 } = require("@apidevtools/openapi-schemas");
const ZSchema = require("z-schema");
// Create a ZSchema validator
let validator = new ZSchema();
// Validate an OpenAPI definition against the OpenAPI v3.0 specification
validator.validate(openapiDefinition, openapiV31);
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
To build the project locally on your computer:
Clone this repo
git clone https://github.com/APIDevTools/openapi-schemas.git
Install dependencies
npm install
Build the code
npm run build
Run the tests
npm test
OpenAPI Schemas is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Thanks to these awesome companies for their support of Open Source developers ❤
FAQs
JSON Schemas for every version of the OpenAPI Specification
The npm package @apidevtools/openapi-schemas receives a total of 0 weekly downloads. As such, @apidevtools/openapi-schemas popularity was classified as not popular.
We found that @apidevtools/openapi-schemas demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers 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
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.