I have this RAML:

    /pages: &pages
      type: collection
      /{pageId}:
        uriParameters:
          pageId:
            type: number
            description: The page's numeric ID
            required: true

a request to this URI http://localhost:3000/api/pages/examples returns the example, when it should have thrown a validation error, as "examples" is not a valid number

Such parameter will be used in the package.json file

If there is a baseUri property it should commented first.

then the property should be added:

baseUri: /{{apiPath}}

Apikit registers itself on '/api':

apiKit.register('/api', app, {
  ramlFile: path.join(__dirname, '/assets/raml/api.raml'),
  enableConsole: true,
  enableMocks: true
});

But the route overload is not on /api:

// Adding business logic to a valid RAML Resource
// apiKit.get('/examples/:exampleId', function(req, res) {
//   res.send({ name: 'example' });
// });

If there is no custom error handler, validations should at least say which field was invalid, and what is expected.

Evaluate using cache or making it synchronous

running something like apikit-node routes should print something like:

GET /resources
POST /resources
GET /resources/{resourceId}
...

To provide baseUri, if there is no one it should be extracted from the RAML file

Currently only json schemas are being validated. XML should be also considered

If the RAML file has a syntax or grammar error, the application does not show any error messages or helpful debugging information on startup.

API console should at least show there is an error with the RAML file.

When I use a queryParameter with type boolean, no matter what value I send for it, I get Bad Request for everything.

To select between javascript, typescript and coffeescript

By default return first status specified in the RAML file

When logging the startup, the logged port does not match the one used in the app (it is harcoded to 3000)

if (!module.parent) {
  app.listen(app.get('port'));
  console.log('listening on port 3000');
}

possible fix:

if (!module.parent) {
  var port = app.get('port');
  app.listen(port);
  console.log('listening on port ' + port);
}

jcenturion / raml-toolkit > mulesoft / apikit-node

If portalController.query is undefined or not a function, apikit should not add the route

apiKit.get      ('/portals', portalController.query);

In case of error an exception should be thrown and it should be responsibility of the exception handling middleware to return the correct response.

A newly scaffolded api has a lot of dev-dependencies that don't seem to be needed:

{
  "name": "raml-app",
  "version": "0.0.1",
  "private": true,
  "dependencies": {
    "express": "3.4.4"
  },
  "devDependencies": {
    "grunt": "~0.4.2",
    "grunt-contrib-coffee": "0.7.0",
    "grunt-contrib-watch": "~0.5.3",
    "grunt-contrib-copy": "~0.4.1",
    "grunt-coffeelint": "0.0.8",
    "grunt-contrib-clean": "~0.5.0",
    "grunt-mocha-test": "~0.8.1",
    "mocha": "1.15.1",
    "should": "2.1.1",
    "supertest": "~0.8.2",
    "grunt-nodemon": "~0.1.2",
    "grunt-concurrent": "~0.4.2",
    "load-grunt-tasks": "~0.2.1",
    "grunt-wait": "~0.1.0",
    "grunt-contrib-jshint": "~0.8.0"
  }
}

If I had a little more information about which part of the pipeline a request goes through, I may be able to debug apikit's issues better

The developer should be able to setup the API console path. Moreover, the developer should be warn about that the API console path is being overwritten.

Related to #42.

https://github.com/vojtajina/grunt-npm

It should show the help instead when receiving invalid params

When a value is not send in the request and there's a default specified in the RAML file, it should be added to the request, before the validations.

I run coffee ../apikit-node-cli/src/apikit-node-cli.coffee api.raml and the output folder did not have the api.raml file in the assets folder.

I have this RAML:

    /pages:
      type: collection
      /{pageId}:

with this setup:

apiKit.register('/api', app, {
  ramlFile: path.join(__dirname, '/assets/raml/api.raml'),
  enableConsole: true,
  enableMocks: true
});

I expect a GET /localhost:3000/pages/api to 404, but it returns the sample for /pages/api

So that we always use the lates apikit-node verison, at least for the development version, it would be useful for the scaffold to include a bower.json file such as:

{
  "dependencies": {
    "osprey": "[email protected]:mulesoft/osprey.git"
  }
}