Skip to content

Cli tool (and library) for converting JSON mock objects to OpenAPI schemas

Notifications You must be signed in to change notification settings

OzzyCzech/mock-to-openapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSON mock to OpenAPI converter

NPM Downloads NPM Version NPM License Last Commit GitHub Workflow Status

Cli tool (and library) for converting JSON mock objects to OpenAPI schemas.

Install

npm install --global mock-to-openapi 

Usage

Following command will convert all *.json files from directory ./examples to YAML OpenAPI schemas.

mock-to-openapi ./examples

Example

Let's have, for example, json object with:

{
	"title": "This is title",
	"author": "Roman Ožana",
	"content": "This is just an example",
	"date": "2020-05-12T23:50:21.817Z"
}

Tool mock-to-openapi converts JSON to the OpenAPI specification as follows:

type: object
properties:
  title:
    type: string
    example: This is title
  author:
    type: string
    example: Roman Ožana
  content:
    type: string
    example: This is just an example
  date:
    type: string
    format: date-time
    example: 2020-05-12T23:50:21.817Z

About

Cli tool (and library) for converting JSON mock objects to OpenAPI schemas

Resources

Stars

Watchers

Forks

Packages

No packages published