Git Product home page Git Product logo

loopback-swagger-cli's Introduction

The loopback:swagger converter is nice, and this tool makes it a bit nicer:

  • batch conversion (without interaction needed)
  • copy relations,acl etc defined in swagger

Basically it allows you to do a swagger/loopback syntax-mashup in 1 jsonfile. This allows you to model your api's using one model file. (instead of slapping your head around files)

Usage

npm install -g loopback-swagger-cli

then extend your swagger file with strongloop syntax like so:

{
  ...
  "pet": {
    "type": "object",
    "required": [
      "id",
      "name"
    ],
    "dataSource": "db",          <--
    "public":true,               <--
    "relations": {               <--
      "owner": {                 <-- see strongloop 
        "type": "belongsTo",     <-- model jsondocs for
        "model": "owner",        <-- fields / syntax
        "foreignKey": ""         <--
      }                          <--
    },
  ...

and then

$ slc loopback:swagger swagger.json # only needed once (see note)
$ loopback-swagger-cli swagger.json server/models server/model-config.json
writing /server/models/owner.json
writing /server/models/pet.json 
writing /server/model-config.json

NOTE: this cli-tool will leave the .js files alone, however use the loopback:swagger cmd to generate them otherwise loopback will complain.

Example repo

here's an example of a loopback api served from one coffeescript-jsonfile:

https://github.com/coderofsalvation/loopback-swagger-cli-example

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.