Package Health Score

91 / 100

security
No known security issues
popularity
Influential project
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.2.0	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.1.5	\|	06/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.22.3	\|	09/2019		0 C 0 H 1 M 0 L	0 H 0 M 0 L
0.16.1	\|	07/2016		0 C 0 H 1 M 0 L	0 H 0 M 0 L
0.15.3	\|	07/2016		0 C 0 H 1 M 0 L	0 H 0 M 0 L

License

MIT

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

Influential project

Weekly Downloads (655,789)

GitHub Stars: 23.62K
Forks: 2.3K
Contributors: 210

Direct Usage Popularity

The npm package redoc receives a total of 655,789 downloads a week. As such, we scored redoc popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package redoc, we found that it has been starred 23,617 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: No
Contributors: 210
Funding: No

A good and healthy external contribution signal for redoc 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 redoc is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 341
Open PR: 13
Last Release: 1 month ago
Last Commit: 24 days ago

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

We found that redoc 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: >=6.9

Age: 9 years
Dependencies: 22 Direct
Versions: 227
Install Size: 7.05 MB
Dist-tags: 2
# of Files: 175
Maintainers: 1
TS Typings: Yes

redoc 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 redoc?

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

Redocly / redoc / cli / index.ts View on Github

async function serve(port: number, pathToSpec: string, options: Options = {}) {
  let spec = await loadAndBundleSpec(pathToSpec);
  let pageHTML = await getPageHTML(spec, pathToSpec, options);

  const server = createServer((request, response) => {
    console.time('GET ' + request.url);
    if (request.url === '/redoc.standalone.js') {
      respondWithGzip(
        createReadStream(join(BUNDLES_DIR, 'redoc.standalone.js'), 'utf8'),
        request,
        response,
        {
          'Content-Type': 'application/javascript',
        },
      );
    } else if (request.url === '/') {
      respondWithGzip(pageHTML, request, response, {
        'Content-Type': 'text/html',

View more ways to use redoc

Generate beautiful API documentation from OpenAPI

About Redoc

Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.

By default Redoc offers a three-panel, responsive layout:

The left panel contains a search bar and navigation menu.
The central panel contains the documentation.
The right panel contains request and response examples.

Redoc demo

Live demo

If you want to see how Redoc renders your OpenAPI definition, you can try it out online at https://redocly.github.io/redoc/.

A version of the Swagger Petstore API is displayed by default. To test it with your own OpenAPI definition, enter the URL for your definition and select TRY IT.

Redoc features

Responsive three-panel design with menu/scrolling synchronization
Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0
Ability to integrate your API introduction into the side menu
High-level grouping in side menu with the x-tagGroups specification extension
Simple integration with create-react-app
Code samples support (with vendor extension)

Usage

Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.

Generate documentation from the CLI

If you have Node installed, quickly generate documentation using npx:

npx @redocly/cli build-docs openapi.yaml

The tool outputs by default to a file named redoc-static.html that you can open in your browser.

> Redocly CLI does more than docs; check it out and add linting, bundling, and more to your API workflow.

Add an HTML element to the page

Create an HTML page, or edit an existing one, and add the following within the body tags:

Open the HTML file in your browser, and your API documentation is shown on the page.

Add your own spec-url to the `` tag; this attribute can also be a local file. The JavaScript library can also be installed locally using npm and served from your own server, see the HTML deployment documentation for more details.

More usage options

Check out the deployment documentation for more options, and detailed documentation for each.

Redoc vs. Redocly API Reference

Redoc is Redocly's community-edition product. Looking for something more? We also offer hosted API reference documentation with additional features including:

Try-it console
Automated code samples
Pagination
Extra theme options

Documentation and resources

Reference docs - we take care of the hosting
Redoc - detailed documentation for this open source project (also in the docs/ folder)
Command-line interface to bundle your docs into a web-ready HTML file
API linting, bundling, and much more with open source Redocly CLI

Showcase

A sample of the organizations using Redocly tools in the wild:

Pull requests to add your own API page to the list are welcome

Configuration

Redoc is highly configurable, see the configuration documentation for details.

OpenAPI specification extensions

Redoc uses the following specification extensions:

x-logo - is used to specify API logo
x-traitTag - useful for tags that refer to non-navigation properties like Pagination, Rate-Limits, etc
x-codeSamples - specify operation code samples
x-badges - specify operation badges
x-examples - specify JSON example for requests
x-nullable - mark schema param as a nullable
x-displayName - specify human-friendly names for the menu categories
x-tagGroups - group tags by categories in the side menu
x-servers - ability to specify different servers for API (backported from OpenAPI 3.0)
x-ignoredHeaderParameters - ability to specify header parameter names to ignore
x-additionalPropertiesName - ability to supply a descriptive name for the additional property keys
x-summary - for Response object, use as the response button text, with description rendered under the button
x-extendedDiscriminator - in Schemas, uses this to solve name-clash issues with the standard discriminator
x-explicitMappingOnly - in Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object

Releases

The README for the 1.x version is on the v1.x branch.

All the 2.x releases are deployed to npm and can be used with Redocly-cdn:

particular release, for example, v2.0.0: https://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js
latest release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js

Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN (deprecated):

particular release, for example v1.2.0: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
v1.x.x release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
latest release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - points to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.

Development

see CONTRIBUTING.md

redoc development dependencies

@cypress/webpack-preprocessor @size-limit/file @types/chai @types/dompurify @types/enzyme @types/enzyme-to-json @types/jest @types/json-pointer @types/lunr @types/mark.js @types/marked @types/node @types/prismjs @types/prop-types @types/react @types/react-dom @types/styled-components @types/tapable @types/webpack @types/webpack-env @types/yargs @typescript-eslint/eslint-plugin @typescript-eslint/parser beautify-benchmark conventional-changelog-cli copy-webpack-plugin core-js css-loader cypress enzyme enzyme-to-json esbuild-loader eslint eslint-plugin-import eslint-plugin-react eslint-plugin-react-hooks fork-ts-checker-webpack-plugin html-webpack-plugin husky jest jest-environment-jsdom js-yaml license-checker lodash.noop mobx outdent prettier pretty-quick raf react react-dom rimraf shelljs size-limit style-loader styled-components ts-jest ts-node tslib typescript unfetch url webpack webpack-cli webpack-dev-server webpack-node-externals workerize-loader

FAQs

What is redoc?

ReDoc. Visit Snyk Advisor to see a full health score report for redoc, including popularity, security, maintenance & community analysis.

Is redoc popular?

The npm package redoc receives a total of 655,789 weekly downloads. As such, redoc popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is redoc well maintained?

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

Is redoc safe to use?

The npm package redoc 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 20 November-2024, at 18:04 (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