{"id":17645069,"url":"https://github.com/ikemtz/openapi-mermaid","last_synced_at":"2025-09-10T02:44:50.098Z","repository":{"id":39760896,"uuid":"373413048","full_name":"ikemtz/openapi-mermaid","owner":"ikemtz","description":"Generates Mermaid diagrams from OpenApi Docs","archived":false,"fork":false,"pushed_at":"2025-04-06T20:13:01.000Z","size":453,"stargazers_count":11,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T21:23:56.057Z","etag":null,"topics":["class","diagrams","mermaid","openapi","swagger"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ikemtz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-03T07:04:59.000Z","updated_at":"2025-03-30T22:18:01.000Z","dependencies_parsed_at":"2024-02-02T05:23:56.562Z","dependency_job_id":"818a5ddd-07b7-4b29-91af-7583195702ac","html_url":"https://github.com/ikemtz/openapi-mermaid","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.09375,"last_synced_commit":"c3b9500e0d6fe14e1bce3e889450b31054418ba4"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-mermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-mermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-mermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-mermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ikemtz","download_url":"https://codeload.github.com/ikemtz/openapi-mermaid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249707194,"owners_count":21313788,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["class","diagrams","mermaid","openapi","swagger"],"created_at":"2024-10-23T10:46:13.677Z","updated_at":"2025-04-19T13:49:14.767Z","avatar_url":"https://github.com/ikemtz.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi-mermaid\nGenerates Mermaid diagrams from OpenApi Docs\n\n\n[![Build Status](https://ikemtz.visualstudio.com/CI%20CD/_apis/build/status/openapi-mermaid?branchName=master)](https://ikemtz.visualstudio.com/CI%20CD/_build/latest?definitionId=20\u0026branchName=master) [![npm version](https://badge.fury.io/js/openapi-mermaid.svg)](https://www.npmjs.com/package/openapi-mermaid) [![npm downloads](https://img.shields.io/npm/dt/openapi-mermaid)](https://www.npmjs.com/package/openapi-mermaid) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-mermaid\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-mermaid) [![Issues](https://img.shields.io/github/issues-raw/ikemtz/OpenApi-mermaid)](https://github.com/ikemtz/openapi-mermaid/issues) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-mermaid\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-mermaid) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-mermaid\u0026metric=ncloc)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-mermaid) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-mermaid\u0026metric=security_rating)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-mermaid)\n\n# OpenApi-mermaid\n\nNPM package use to generate mermaid diagram documentation for endpoints documented by swagger using the [OpenAPI spec](https://swagger.io/docs/specification/about/).\n\n## TypeScript usage with a hosted OpenApi Spec document.\n\n```javascript\nimport { generateDiagrams } from 'openapi-mermaid';\n\ngenerateDiagrams({\n  openApiJsonUrl: '{Your Swagger Enpoint URL here}',\n  outputPath: './{outputFolder}/',\n  outputFileName: 'class-diagram', /* This is an optional parameter */\n});\n```\n\n## TypeScript usage with an OpenApi Spec document stored on your local computer.\n\n```javascript\nimport { generateDiagrams } from 'openapi-mermaid';\n\ngenerateDiagrams({\n  openApiJsonFileName: '{location and file name of your OpenApi document}',\n  outputPath: './{outputFolder}/',\n  outputFileName: 'class-diagram', /* This is an optional parameter */\n});\n```\n\n## Javascript usage with a hosted OpenApi Spec document.\n\n```javascript\nconst generator = require('openapi-mermaid');\n\ngenerator.generateDiagrams({\n  openApiJsonUrl: '{Your Swagger Enpoint URL here}',\n  outputPath: './{outputFolder}/',\n});\n```\n\n## Javascript usage with an OpenApi Spec document stored on your local computer.\n\n```javascript\nconst generator = require('openapi-mermaid');\n\ngenerator.generateDiagrams({\n  openApiJsonFileName: '{location and file name of your OpenApi document}',\n  outputPath: './{outputFolder}/',\n});\n```\n\n## Working example with NRSRx based service\n\n```javascript\nimport { generateDiagrams } from 'openapi-mermaid';\n\ngenerateDiagrams({\n  openApiJsonUrl: 'https://im-wa-cmpo-nrsr.azurewebsites.net/swagger/v1/swagger.json',\n  outputPath: './models/',\n  typeFilterCallBack: (val, i, arr) =\u003e !val.name.endsWith('ODataEnvelope'),\n  valuePropertyTypeFilterCallBack: (val, i, arr) =\u003e !val.name.startsWith('created') \u0026\u0026 !val.name.startsWith('updated'),\n});\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fopenapi-mermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fikemtz%2Fopenapi-mermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fopenapi-mermaid/lists"}