swagger-ui-dist

v5.18.2

[![NPM version](https://badge.fury.io/js/swagger-ui-dist.svg)](http://badge.fury.io/js/swagger-ui-dist) For more information about how to use this package see README

Latest version published 15 days ago

License: Apache-2.0

NPM

GitHub

Package Health Score

89 / 100

security
No known security issues
popularity
Key ecosystem project
maintenance
Healthy
community
Active

Security

No known security issues

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
5.18.2	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.17.14	\|	05/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.19.1	\|	06/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.52.5	\|	10/2021		0 C 0 H 2 M 0 L	0 H 0 M 0 L
3.51.2	\|	07/2021		0 C 0 H 2 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

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

Key ecosystem project

Weekly Downloads (3,331,649)

GitHub Stars: 26.55K
Forks: 8.96K
Contributors: 400

Direct Usage Popularity

The npm package swagger-ui-dist receives a total of 3,331,649 downloads a week. As such, we scored swagger-ui-dist popularity level to be Key ecosystem project.

Based on project statistics from the GitHub repository for the npm package swagger-ui-dist, we found that it has been starred 26,545 times.

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

Community

Active

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

A good and healthy external contribution signal for swagger-ui-dist project, which invites more than one hundred open source maintainers to collaborate on the repository.

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

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 1.13K
Open PR: 79
Last Release: 15 days ago
Last Commit: 1 month ago

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

We found that swagger-ui-dist demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

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: 8 years
Dependencies: 1 Direct
Versions: 316
Install Size: 11.2 MB
Dist-tags: 3
# of Files: 24
Maintainers: 4
TS Typings: Yes

swagger-ui-dist 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.

Not sure how to use swagger-ui-dist?

To help you get started, we've collected the most common ways that swagger-ui-dist is being used within popular public projects.

anttiviljami / serverless-openapi-joi-boilerplate / scripts / build-swaggerui.js View on Github

// validate openapi and warn in case there are issues
  const { valid, errors } = validate(apispec, 3);
  if (valid) {
    console.info('\x1b[32m[success]\x1b[0m Document is valid OpenAPI v3!');
  } else {
    console.warn(`\x1b[33m[warning]\x1b[0m Document is not valid OpenAPI!\n ${errors.length} validation errors:\n` +
      JSON.stringify(errors, null, 2));
  }

  // write to swagger.json file under static/
  const swaggerFile = path.join(outputPath, 'swagger.json');
  fs.writeFileSync(swaggerFile, JSON.stringify(apispec));
  console.info(`[info] Wrote OpenAPI spec to ${path.basename(outputPath)}/${path.basename(swaggerFile)}`);

  // copy swagger ui dist files
  const swaggerDist = getAbsoluteFSPath();
  const swaggerFiles = fs.readdirSync(swaggerDist)
    .filter(file => !file.endsWith('.map'));
  for (const file of swaggerFiles) {
    const source = path.join(swaggerDist, file);
    const target = path.join(outputPath, file);
    fs.writeFileSync(target, fs.readFileSync(source));
  }
  console.info(`[info] Copied ${swaggerFiles.length} SwaggerUI files to ${path.basename(outputPath)}/`);

  // replace api url to relative ./swagger.json in index.html
  const index = fs.readFileSync(path.join(swaggerDist, 'index.html'));
  const replaced = index.toString()
    .replace(new RegExp('https://petstore.swagger.io/v2/swagger.json', 'g'), './swagger.json')
    .replace(new RegExp('http://example.com/api', 'g'), './swagger.json')
  fs.writeFileSync(path.join(outputPath, 'index.html'), replaced);
  console.info(`[info] Replaced index.html swagger url with relative swagger.json`);

View more ways to use swagger-ui-dist

Swagger UI Dist

Anonymized analytics

SwaggerUI Dist uses Scarf to collect anonymized installation analytics. These analytics help support the maintainers of this library and ONLY run during installation. To opt out, you can set the scarfSettings.enabled field to false in your project's package.json:

// package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

Alternatively, you can set the environment variable SCARF_ANALYTICS to false as part of the environment that installs your npm packages, e.g., SCARF_ANALYTICS=false npm install.

API

This module, swagger-ui-dist, exposes Swagger-UI's entire dist folder as a dependency-free npm module. Use swagger-ui instead, if you'd like to have npm install dependencies for you.

SwaggerUIBundle and SwaggerUIStandalonePreset can be imported:

  import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"

To get an absolute path to this directory for static file serving, use the exported getAbsoluteFSPath method:

const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()

// then instantiate server that serves files from the swaggerUiAssetPath

For anything else, check the Swagger-UI repository.

swagger-ui-dist dependencies

@scarf/scarf

FAQs

What is swagger-ui-dist?

[![NPM version](https://badge.fury.io/js/swagger-ui-dist.svg)](http://badge.fury.io/js/swagger-ui-dist). Visit Snyk Advisor to see a full health score report for swagger-ui-dist, including popularity, security, maintenance & community analysis.

Is swagger-ui-dist popular?

The npm package swagger-ui-dist receives a total of 3,331,649 weekly downloads. As such, swagger-ui-dist popularity was classified as a key ecosystem project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is swagger-ui-dist well maintained?

We found that swagger-ui-dist demonstrated a healthy version release cadence and project activity. It has a community of 400 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is swagger-ui-dist safe to use?

The npm package swagger-ui-dist was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 November-2024, at 04:49 (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