Giter Club home page Giter Club logo

create-raml's People

Contributors

dependabot[bot] avatar ivanoff avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

create-raml's Issues

Support routes attached to express.Router instance

This doesn't seem to work with routes that are defined on an express.Router() instance.

For example:

const express = require('express');
const app = express();
const router = express.Router();
const Raml = require('create-raml');

const raml = new Raml({
        express: app,
        path: '/api.raml', // path to API RAML
        storeResponses: true, // store first response as example
        guessAll: true, // make description quite pretty
        title: 'Example API',
        baseUri: 'http://localhost:8080',
        version: 'v1'
});

app.get('/test', function(req, res){return res.send('test')}); //is added to raml
router.get('/test2', function(req, res){return res.send('test2')}); //is not added to raml

app.use('/api', router); //i.e. to assign the routes to a common baseUrl which could be dynamic by environment

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.