@scalar/express-api-reference

v0.4.166

A middleware for using the Scalar API reference with Express For more information about how to use this package see README

Latest version published 6 days ago

License: MIT

NPM

GitHub

Package Health Score

90 / 100

security
No known security issues
popularity
Recognized
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
0.4.166	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.165	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.41	\|	04/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.75	\|	03/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.11	\|	12/2023	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

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

Recognized

Weekly Downloads (4,115)

GitHub Stars: 6.98K
Forks: 216
Contributors: 90

Direct Usage Popularity

The npm package @scalar/express-api-reference receives a total of 4,115 downloads a week. As such, we scored @scalar/express-api-reference popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @scalar/express-api-reference, we found that it has been starred 6,980 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: Yes
Code of Conduct: Yes
Contributors: 90
Funding: No

With more than 10 contributors for the @scalar/express-api-reference repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 127
Open PR: 13
Last Release: 6 days ago
Last Commit: 5 days ago

Further analysis of the maintenance status of @scalar/express-api-reference based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @scalar/express-api-reference 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: >=18

Age: 12 months
Dependencies: 1 Direct
Versions: 295
Install Size: 22.4 kB
Dist-tags: 1
# of Files: 7
Maintainers: 8
TS Typings: No

@scalar/express-api-reference 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

Scalar Express API Reference Plugin

This middleware provides an easy way to render a beautiful API reference based on an OpenAPI/Swagger file with Express.

Installation

npm install @scalar/express-api-reference

Usage

Set up Express and pass an URL to an OpenAPI/Swagger document to the apiReference middleware:

> Wait, but how do we get the OpenApiSpecification? 🤔 There are multiple ways to generate an OpenAPI/Swagger file for Express. The most popular way is to use swagger-jsdoc.

import { apiReference } from '@scalar/express-api-reference'

app.use(
  '/reference',
  apiReference({
    spec: {
      // Put your OpenAPI url here:
      url: '/openapi.json',
    },
  }),
)

The Express middleware takes our universal configuration object, read more about configuration in the core package README.

Themes

The middleware comes with a custom theme for Express. You can use one of the other predefined themes (alternate, default, moon, purple, solarized) or overwrite it with none. All themes come with a light and dark color scheme.

import { apiReference } from '@scalar/express-api-reference'

app.use(
  '/reference',
  apiReference({
    theme: 'purple',
    spec: {
      url: '/openapi.json',
    },
  }),
)

Custom CDN

You can use a custom CDN ，default is https://cdn.jsdelivr.net/npm/@scalar/api-reference.

import { apiReference } from '@scalar/express-api-reference'

app.use(
  '/reference',
  apiReference({
    cdn: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference',
    spec: {
      url: '/openapi.json',
    },
  }),
)

Community

We are API nerds. You too? Let’s chat on Discord:

License

The source code in this repository is licensed under MIT.

@scalar/express-api-reference dependencies

@scalar/types

@scalar/express-api-reference development dependencies

@types/express express tsup vite vitest @scalar/api-reference

FAQs

What is @scalar/express-api-reference?

A middleware for using the Scalar API reference with Express. Visit Snyk Advisor to see a full health score report for @scalar/express-api-reference, including popularity, security, maintenance & community analysis.

Is @scalar/express-api-reference popular?

The npm package @scalar/express-api-reference receives a total of 4,115 weekly downloads. As such, @scalar/express-api-reference popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @scalar/express-api-reference well maintained?

We found that @scalar/express-api-reference demonstrated a healthy version release cadence and project activity. It has a community of 90 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @scalar/express-api-reference safe to use?

The npm package @scalar/express-api-reference 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 3 November-2024, at 16:57 (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 (4,115)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Scalar Express API Reference Plugin

Installation

Usage

Themes

Custom CDN

Community

License

@scalar/express-api-reference dependencies

@scalar/express-api-reference development dependencies

FAQs

What is @scalar/express-api-reference?

Is @scalar/express-api-reference popular?

Is @scalar/express-api-reference well maintained?

Is @scalar/express-api-reference 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