Coder Social home page Coder Social logo

node-hapi-swagger-models's Introduction

hapi-swagger-models

This is a plugin for HAPI v6 or 7. When installed it will generate javascript models from a self-documenting Swagger API. Currently only Backbone models are supported.

Install

You can add the module to your HAPI project using npm:

$ npm install hapi-swagger-models --save

Adding the plug-in into your project

In your server init file, add the following code after you have created the server object:

server.pack.register({
    plugin: require('hapi-swagger-models'),
    options: {
        api: 'http://localhost:8000/docs',
        filePath: '/static/models/models.js'
    }
}, function(err) {
    if (err) {
        server.log('hapi-swagger-models load error: ' + err);
    }
});

Testing your config

If you get no errors in the log, you should be able to now access your running HAPI project and add /static/models/models.js (or whatever file path values you supplied) to the end of your root URL to see the backbone models generated.

node-hapi-swagger-models's People

Watchers

Jason Lee Ertle avatar  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.