Code Monkey home page Code Monkey logo

json-to-schema-swagger's Introduction

jsonToSchemaSwagger

Convert class with object json to schema swagger json, where the input.js:

module.exports = {
  ClassName: {
    description: "Class Name",
    type: "object",
    example: {
      id: 1,
      name: "Name",
      tags: [
        { key1: "value 1", key2: 999 },
        { key1: "value 2", other2: 888 }
      ]
    }
  }
};

where example can be a json object with arrays or basic type. The result is:

module.exports = {
  ClassName: {
    description: "Class Name",
    type: "object",
    properties: {
      id: {
        type: "number",
        description: "id",
        example: 1
      },
      name: {
        type: "string",
        description: "name",
        example: "Name"
      },
      tags: {
        type: "array",
        items: {
          type: "object",
          properties: {
            key1: {
              type: "string",
              description: "key1",
              example: "value 1"
            },
            key2: {
              type: "number",
              description: "key2",
              example: 999
            }
          }
        }
      }
    }
  }
};

Usage

Create a js file to process and write:

const util = require("json-to-schema-swagger");

const config = {
  pathSource: "./pathsource",
  pathDestination: "./pathdestination"
};

util.eject(config);

where ./pathsource must to exist, however ./pathdestination will be created if it does not exist

json-to-schema-swagger's People

Contributors

pargon avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.