npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

openapi-mermaid

v3.226.1

Published

Creates Mermaid diagrams using OpenApi v3 docs

Downloads

1,188

Readme

openapi-mermaid

Generates Mermaid diagrams from OpenApi Docs

Build Status npm version npm downloads Quality Gate Status Issues Coverage Lines of Code Security Rating

OpenApi-mermaid

NPM package use to generate mermaid diagram documentation for endpoints documented by swagger using the OpenAPI spec.

TypeScript usage with a hosted OpenApi Spec document.

import { generateDiagrams } from 'openapi-mermaid';

generateDiagrams({
  openApiJsonUrl: '{Your Swagger Enpoint URL here}',
  outputPath: './{outputFolder}/',
  outputFileName: 'class-diagram', /* This is an optional parameter */
});

TypeScript usage with an OpenApi Spec document stored on your local computer.

import { generateDiagrams } from 'openapi-mermaid';

generateDiagrams({
  openApiJsonFileName: '{location and file name of your OpenApi document}',
  outputPath: './{outputFolder}/',
  outputFileName: 'class-diagram', /* This is an optional parameter */
});

Javascript usage with a hosted OpenApi Spec document.

const generator = require('openapi-mermaid');

generator.generateDiagrams({
  openApiJsonUrl: '{Your Swagger Enpoint URL here}',
  outputPath: './{outputFolder}/',
});

Javascript usage with an OpenApi Spec document stored on your local computer.

const generator = require('openapi-mermaid');

generator.generateDiagrams({
  openApiJsonFileName: '{location and file name of your OpenApi document}',
  outputPath: './{outputFolder}/',
});

Working example with NRSRx based service

import { generateDiagrams } from 'openapi-mermaid';

generateDiagrams({
  openApiJsonUrl: 'https://im-wa-cmpo-nrsr.azurewebsites.net/swagger/v1/swagger.json',
  outputPath: './models/',
  typeFilterCallBack: (val, i, arr) => !val.name.endsWith('ODataEnvelope'),
  valuePropertyTypeFilterCallBack: (val, i, arr) => !val.name.startsWith('created') && !val.name.startsWith('updated'),
});