GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → rmariuzzo → markdown-swagger

rmariuzzo / markdown-swagger

Licence: MIT license
Generate API docs from Swagger file into markdown file.

Programming Languages

javascript
184084 projects - #8 most used programming language

Labels

markdownswagger-api

Projects that are alternatives of or similar to markdown-swagger

connexion-example-redis-kubernetes
Connexion Example REST Service with Redis Store
Stars: ✭ 24 (-65.22%)
Mutual labels:  swagger-api
swagger-brake
Swagger contract checker for breaking API changes
Stars: ✭ 49 (-28.99%)
Mutual labels:  swagger-api
swagger-showdoc
一个将swagger的Json文件转换为ShowDoc的小工具
Stars: ✭ 33 (-52.17%)
Mutual labels:  swagger-api
MsCoreOne
MsCoreOne is a simple Ecommerce with using many technologies such as .NET 5, Entity Framework Core 5, React 16.13 with modern Clean Architecture, Domain-Driven Design, CQRS, SOLID, Identity Server 4, Blazor. It will focus on resolving the problems always see in the process to develop projects.
Stars: ✭ 77 (+11.59%)
Mutual labels:  swagger-api
swaggerql
Easily and simply convert SQL database into a REST API with Swagger documentation
Stars: ✭ 40 (-42.03%)
Mutual labels:  swagger-api
Swagger Js
Javascript library to connect to swagger-enabled APIs via browser or nodejs
Stars: ✭ 2,319 (+3260.87%)
Mutual labels:  swagger-api
Swagger Core
Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
Stars: ✭ 6,898 (+9897.1%)
Mutual labels:  swagger-api
Swagger Ui
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Stars: ✭ 21,279 (+30739.13%)
Mutual labels:  swagger-api
Swagger Node
Swagger module for node.js
Stars: ✭ 3,917 (+5576.81%)
Mutual labels:  swagger-api
travels-java-api
An API for travel management. It is built with Java, Spring Boot, and Spring Framework. A toy-project to serve as a theoretical basis for the Medium series of articles I wrote about Java+Spring.
Stars: ✭ 139 (+101.45%)
Mutual labels:  swagger-api
clubi
A group-oriented social media platform written in Laravel and Vue
Stars: ✭ 29 (-57.97%)
Mutual labels:  swagger-api

Markdown Swagger

Generate API docs from Swagger file into markdown file.

Mardown Swagger Example

Installation

npm install markdown-swagger

Usage

markdown-swagger ./api/swagger/swagger.yaml ./README.md

This will read the specified swagger file and generate a table describing the API inside the target markdown file.

The markdown-swagger script will look for the for the following piece of text inside the target markdown file to do its stuff:

<!-- markdown-swagger -->
  Everything here will be replaced by markdown-swagger
<!-- /markdown-swagger -->
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].