Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/martinm85/openapi-dotnet-tools

Reads Open API document, generates Markdown files and markmap files
https://github.com/martinm85/openapi-dotnet-tools

markmap markmap-lib mindmap openapi openapi-specification

Last synced: 25 days ago
JSON representation

Reads Open API document, generates Markdown files and markmap files

Host: GitHub
URL: https://github.com/martinm85/openapi-dotnet-tools
Owner: MartinM85
License: mit
Created: 2023-09-10T16:43:25.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-09-30T16:51:42.000Z (about 1 month ago)
Last Synced: 2024-10-14T05:02:53.541Z (25 days ago)
Topics: markmap, markmap-lib, mindmap, openapi, openapi-specification
Language: C#
Homepage:
Size: 1.77 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# openapi-dotnet-tools

The Open API tools allow you to read the document with Open API definition for REST API and generate markmap file for an endpoint or a schema.

[Markmap](https://github.com/markmap/markmap) is a tool that visualizes your Markdown as mindmaps.

**Visualization of endpoint**

![](Assets/endpoint.png)

**Visualization of schema**

![](Assets/schema.png)

The repository contains
- command line tool for generating markmap files
- .NET library for creating markmap files
- application for displaying generated markmap files

## OpenAPI Tools command line

[![NuGet Version](https://buildstats.info/nuget/Machy.OpenApi.Tools.Cli)](https://www.nuget.org/packages/Machy.OpenApi.Tools.Cli/)

The console application that generates Markdown files and markmap files.

### Installation

To install the tool via `dotnet tool`:

* Run the command `dotnet tool install --global Machy.OpenApi.Tools.Cli`

Read more: [OpenAPI Tools CLI](OpenApi.Tools.CLI/README.md)

## OpenAPI Tools library

[![NuGet Version](https://buildstats.info/nuget/Machy.OpenApi.Tools.Core)](https://www.nuget.org/packages/Machy.OpenApi.Tools.Core/)

The .NET library that generates Markdown files and markmap files.

### Installation via NuGet

To install the client library via NuGet:

* Search for `OpenApi.Tools.Core` in the NuGet Library, or
* Type `Install-Package OpenApi.Tools.Core` into the Package Manager Console.

Read more: [OpenAPI Tools library](OpenApi.Tools.Core/README.md)

## Markmap files viewer

The application which allows you to display and browse markmap files.

### MAUI

Read more: [Markmap files viewer MAUI](OpenApi.Tools.MarkmapViewer/README.md)

### WPF

Read more: [Markmap files viewer WPF](OpenApi.Tools.MarkmapViewer/README.md)

## Change appearance

Both, command line tool and .NET library allow to modify appearance of the markmap file.

Read more: [Appearance](docs/Appearance.md)

## Prerequisities

* Required: Either `.NET6` or `.NET7` must be installed on your machine
* Optional: Install npm package [markmap-cli](https://www.npmjs.com/package/markmap-cli) `npm install -g markmap-cli`

## Recommendations

Additionally for Windows OS, to handle long path for generated Markdown or markmap files

> set the value of the parameter HKLM\SYSTEM\CurrentControlSet\Control\FileSystem LongPathsEnabled to 1