Code Monkey home page Code Monkey logo

swag-engine's Introduction

swag-engine

swagger2ts transfer Swagger docs to a controller, which help you write your owner API code and definetion

usage

use in code

import { Cmd } from 'swag-engine';

const cmd = new Cmd(rootPath?, customConfig?);

(async function() {
  // sync remote docs data
  await cmd.ready();

  // get docs update information
  const { boDiffs, modDiffs } = cmd.diff();

  // boDiffs.details: string[] modDiffs.details: string[]

  // update docs information
  cmd.updateMod(mod);
  cmd.updateBo(bo);
  cmd.updateAll();

  // write API code with docs information
  cmd.write();

  // data persistence to swag.lock like yarn.lock
  cmd.save();

  // reget new docs information
  await cmd.syncNew();
}())

use as cmd

config

  • originUrl(string)

swagger api url

  • outDir(string)

auto generate code file path

  • templatePath(string)

your custom template path

  • prettierConfig(object)

generated code is formatted by prettier, your can config your prettier style here;

  • lockPath(string)

lock file path, swag-engine lock the current code version use a lockFile

swag-engine's People

Contributors

jasonhzq 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.