npmpackage.info

openapi-schemas

JSON Schemas for every version of the OpenAPI Specification

2.1.0

MIT

JavaScript

6.94 kB

28,747,336 2.7

Installations

npm install openapi-schemas

Pull Requests

Open

0

Total

1

Closed

0

Merged

1

Issues

Open

2

Total

3

Closed

1

Releases

Unable to fetch releases

Developer

APIDevTools

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=10

Typescript Support

Yes

Node Version

10.24.1

NPM Version

6.14.12 Statistics

34 Stars

47 Commits

5 Forks

3 Watching

1 Branches

5 Contributors

Updated on 20 Aug 2024

Bundle Size

58.67 kB

Minified

6.94 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (56.92%)

TypeScript (43.08%)

Total Downloads

Cumulative downloads

Total Downloads

28,747,336

Last day

-7.8%

10,960

Compared to previous day

Last week

3.5%

61,449

Compared to previous week

Last month

1.4%

254,069

Compared to previous month

Last year

-28.8%

3,154,195

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/openapi-schemas

Versions

OpenAPI Specification Schemas

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. 🤖📦

Installation

You can install OpenAPI Schemas via npm.

1npm install @apidevtools/openapi-schemas

Usage

The default export contains all OpenAPI Specification versions:

1const openapi = require("@apidevtools/openapi-schemas");
2
3console.log(openapi.v1);    // { $schema, id, properties, definitions, ... }
4console.log(openapi.v2);    // { $schema, id, properties, definitions, ... }
5console.log(openapi.v3);    // { $schema, id, properties, definitions, ... }
6console.log(openapi.v31);    // { $schema, id, properties, definitions, ... }

Or you can import the specific version(s) that you need:

1const { openapiV1, openapiV2, openapiV3, openapiV31 } = require("@apidevtools/openapi-schemas");
2
3console.log(openapiV1);    // { $schema, id, properties, definitions, ... }
4console.log(openapiV2);    // { $schema, id, properties, definitions, ... }
5console.log(openapiV3);    // { $schema, id, properties, definitions, ... }
6console.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.

1const { openapiV31 } = require("@apidevtools/openapi-schemas");
2const ZSchema = require("z-schema");
3
4// Create a ZSchema validator
5let validator = new ZSchema();
6
7// Validate an OpenAPI definition against the OpenAPI v3.0 specification
8validator.validate(openapiDefinition, openapiV31);

Contributing

Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.

Building

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

License

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.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.7

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More