annotations-to-swagger

v1.0.8

Scan js files in the current directory, look for annotations based on the JSDoc format (https://brikev.github.io/express-jsdoc-swagger-docs) - generate an openapi.json file - generate a swagger documentation UI (based on openapi.json using swagger-to-stat For more information about how to use this package see README

Latest version published 2 years ago

License: ISC

NPM

GitHub

Package Health Score

36 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.8	\|	02/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.7	\|	01/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (3)

GitHub Stars: 0
Forks: 0
Contributors: 1

Direct Usage Popularity

The npm package annotations-to-swagger receives a total of 3 downloads a week. As such, we scored annotations-to-swagger popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package annotations-to-swagger, we found that it has been starred ? times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like annotations-to-swagger is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Open PR: 0
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of annotations-to-swagger based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for annotations-to-swagger is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 2 Direct
Versions: 10
Install Size: 11.8 MB
Dist-tags: 1
# of Files: 699
Maintainers: 1
TS Typings: No

annotations-to-swagger has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

annotations-to-swagger

Scan js files in the current directory, look for annotations based on the JSDoc format (https://brikev.github.io/express-jsdoc-swagger-docs)

generate an openapi.json file
generate a swagger documentation UI (based on openapi.json using swagger-to-static)

Ideal for integrating with serverless scriptable hooks to generate documentation on the fly.

Usage

Install

npm install annotations-to-swagger --save-dev

yarn add annotations-to-swagger --dev

Use

The generated openapi.json file & swagger will be located in the docs folder

@param {string} serviceName - The name of the service
@param {string} description - The description of the service
@param {string} servers - The servers of the service (comma separated)
@param {string} destinationPath - The path where documentation files will be generated (optional, default: ./docs)

Usage: node ./node_modules/annotations-to-swagger/index.js

Example: node ./node_modules/annotations-to-swagger/index.js myServiceName "This is a description of my service" "https://example.com/dev,https://example.com/prod" ./docs ./src/*.js

serverless usage:

environment:
    DOC_DESCRIPTION: "myServiceName"
    DOC_SERVERS: "https://example.com/dev,https://example.com/prod"
custom:
    scriptable:
        hooks:
            before:package:initialize: node ./node_modules/annotations-to-swagger/index.js ${self:service} "${self:provider.environment.DOC_DESCRIPTION}" "${self:provider.environment.DOC_SERVERS}"

annotations-to-swagger dependencies

express-jsdoc-swagger swagger-to-static

FAQs

What is annotations-to-swagger?

Scan js files in the current directory, look for annotations based on the JSDoc format (https://brikev.github.io/expres... Visit Snyk Advisor to see a full health score report for annotations-to-swagger, including popularity, security, maintenance & community analysis.

Is annotations-to-swagger popular?

The npm package annotations-to-swagger receives a total of 3 weekly downloads. As such, annotations-to-swagger popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is annotations-to-swagger well maintained?

We found indications that annotations-to-swagger is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is annotations-to-swagger safe to use?

While scanning the latest version of annotations-to-swagger, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 30 October-2024, at 16:59 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (3)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

annotations-to-swagger

Usage

Install

Use

annotations-to-swagger dependencies

FAQs

What is annotations-to-swagger?

Is annotations-to-swagger popular?

Is annotations-to-swagger well maintained?

Is annotations-to-swagger safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues