npmpackage.info

Gathering detailed insights and metrics for swagger-jsdoc

swagger-jsdoc

Generates swagger/openapi specification based on jsDoc comments and YAML files.

6.2.8

1,704

MIT

JavaScript

78,658,849 3.4

Installations

npm install swagger-jsdoc

Score

78.2

Supply Chain

99.1

Quality

79.2

Maintenance

100

Vulnerability

License

Pull Requests

Open

8

Total

209

Closed

84

Merged

117

Issues

Open

31

Total

200

Closed

169

Releases

v6.2.1

Published on 18 Apr 2022

v6.2.0

Published on 02 Apr 2022

7.0.0-rc.6

v7.0.0-rc.6

Published on 12 Mar 2021

6.1.0

v6.1.0

Published on 11 Mar 2021

7.0.0-rc.5

v7.0.0-rc.5

Published on 07 Mar 2021

6.0.9

v6.0.9

Published on 07 Mar 2021

View all 65 releases

Developer

Surnet

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=12.0.0

Typescript Support

No

Node Version

12.22.12

NPM Version

6.14.16 Statistics

1,704 Stars

442 Commits

228 Forks

11 Watching

9 Branches

69 Contributors

Updated on 28 Nov 2024

Languages

JavaScript (97.26%)

CSS (2.74%)

Total Downloads

Cumulative downloads

Total Downloads

78,658,849

Last day

0.6%

120,236

Compared to previous day

Last week

-1.3%

625,937

Compared to previous week

Last month

2,711,428

Compared to previous month

Last year

40.3%

25,430,060

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

swagger-jsdoc

This library reads your JSDoc-annotated source code and generates an OpenAPI (Swagger) specification.

Getting started

Imagine having API files like these:

1/**
2 * @openapi
3 * /:
4 *   get:
5 *     description: Welcome to swagger-jsdoc!
6 *     responses:
7 *       200:
8 *         description: Returns a mysterious string.
9 */
10app.get('/', (req, res) => {
11  res.send('Hello World!');
12});

The library will take the contents of @openapi (or @swagger) with the following configuration:

1const swaggerJsdoc = require('swagger-jsdoc');
2
3const options = {
4  definition: {
5    openapi: '3.0.0',
6    info: {
7      title: 'Hello World',
8      version: '1.0.0',
9    },
10  },
11  apis: ['./src/routes*.js'], // files containing annotations as above
12};
13
14const openapiSpecification = swaggerJsdoc(options);

The resulting openapiSpecification will be a swagger tools-compatible (and validated) specification.

swagger-jsdoc example screenshot

System requirements

Node.js 12.x or higher

You are viewing swagger-jsdoc v6 which is published in CommonJS module system.

Installation

1npm install swagger-jsdoc --save

1yarn add swagger-jsdoc

Supported specifications

OpenAPI 3.x
Swagger 2
AsyncAPI 2.0

Validation of swagger docs

By default swagger-jsdoc tries to parse all docs to it's best capabilities. If you'd like to you can instruct an Error to be thrown instead if validation failed by setting the options flag failOnErrors to true. This is for instance useful if you want to verify that your swagger docs validate using a unit test.

1const swaggerJsdoc = require('swagger-jsdoc');
2
3const options = {
4  failOnErrors: true, // Whether or not to throw when parsing errors. Defaults to false.
5  definition: {
6    openapi: '3.0.0',
7    info: {
8      title: 'Hello World',
9      version: '1.0.0',
10    },
11  },
12  apis: ['./src/routes*.js'],
13};
14
15const openapiSpecification = swaggerJsdoc(options);

Documentation

Click on the version you are using for further details:

No vulnerabilities found.

10

Code-Review

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

10

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

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

Pinned-Dependencies

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

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

3.4

/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

swagger-jsdoc

Installations

Score

Pull Requests

8

209

84

117

Issues

31

200

169

Releases

Developer

Surnet

Developer Guide

CommonJS

>=12.0.0

No

12.22.12

6.14.16

Statistics

Languages

Total Downloads

78,658,849

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

swagger-jsdoc

Getting started

System requirements

Installation

Supported specifications

Validation of swagger docs

Documentation

10

10

10

10

0

0

0

0

0

0

0

0

0

3.4

/10