farolfo / raml-server

run a mocked server JUST based on a RAML API's definition .. zero coding

RAML Server

Get a full fake REST API with zero coding by writing a RAML spec.

Why building a new RAML based server? Cause this one works with JSON-Server, so no much code to do (maintain).

This is an open source project, so issues, PRs and suggestions are wellcome.

Install

RAML Server is tested under node v0.12. If you don't have node installed yet, doing it via nvm is recommended.

If you have node installed, run

$ npm install -g raml-server

Usage

Start a server based on the exampleApi.raml file

$ raml-server exampleApi.raml

And hit localhost:3000/songs. Also, later POSTs to /songs on the server will be saved!

How it works?

This is done by generating responses' data reading the JSON schemas with the RAML Mocker, and run with JSON-Server.

Next release fixes

• Support imports in RAML.
• Support nested resources (today it only routes the JSON schema of the top level resources, like /songs).
• RAML 1.0.
• Start a server based on the api.raml file that is on the current directory if no argument is provided.

As seen at

• http://www.programmableweb.com/news/standalone-raml-api-mocking-tools-surface/2015/08/13

raml-server's Issues

One resource method without example will break whole mock

Following RAML will cause raml-server to fail (i've added responses and 204 for delete method):

#%RAML 0.8

title: World Music API
baseUri: http://example.api.com/{version}
version: v1

/songs:
  get:
    queryParameters:
      genre:
        description: filter the song by genre
  post:
  /{songId}:
    get:
      responses:
        200:
          body:
            application/json:
              schema: |
                { "$schema": "http://json-schema.org/schema",
                  "type": "object",
                  "description": "A canonical song",
                  "properties": {
                    "title": { "type": "string" },
                    "artist": { "type": "string"}
                  },
                  "required": [ "title", "artist" ]
                }
    delete:
      description: |
        This method will *delete* an **individual song**
      responses:
        204:

It will work, if i also specify following code for delete method:

body:
  application/json:
    example: ""

So.. i would propose to trait methods without examples like empty ones or just skip them, but warn user about it on start.

post request

Code that we can use to post a song will be very helpful. Can you please provide that so I can test the server with post requests?

Limitation with single RAML file

Do you have intention of solving the single file limitation of the Raml-Server? Also it will be better if implemented as a module.

SyntaxError when using RAML tutorial example (parameters not supported?)

Hi guys,

I'm trying to use the raml-server with the example given in the RAML official 200 tutorial (http://raml.org/developers/raml-200-tutorial), jukebox-api.raml.

I get the following error:

$ raml-server jukebox-api.raml 
Error parsing: SyntaxError: Unexpected token <

Does it mean that raml-server doesn't support parameters (<< resourcePathName >>, ...) as explained in http://raml.org/developers/raml-200-tutorial#parameters ?
Or do I miss something?

can not install in node6.9.0

npm ERR! node v6.9.0
npm ERR! npm v3.10.8

npm ERR! shasum check failed for /var/folders/k4/9bkz633525d0xjdghft_b3f80000gn/T/npm-6176-d060d5f6/registry.npmjs.org/faker/-/faker-3.1.0.tgz
npm ERR! Expected: 0f908faf4e6ec02524e54a57e432c5c013e08c9f
npm ERR! Actual: 4424c6a2142e4bb653fcb78a886a1f0b23cd391d
npm ERR! From: https://registry.npmjs.org/faker/-/faker-3.1.0.tgz

RAML 1.0 support

Planning support for RAML 1.0? Is this still being maintained?

Thanks.

Can't get it to work

I installed it locally (w/o the -g option).
Then run it as: raml-server path-to-raml-file/api.raml

Then hitting the top level resources at http://localhost:3000/top-level-resources always returns empty object {}, while the server logs reports 404. I made sure that my raml file has no include (only a single file), and has a schema defined for the response.

I tried with your exampleApi.raml, and hit http://localhost:3000/songs, got same result (404). In any case, if I hit the base url http://localhost:3000/, a successful page is returned with the first sentence "Congrats! You're successfully running JSON Server".

Any idea?

Thanks.

Sames not work good with included

Sames not work good with included

like:

traits: !include xxx/xxxx.yaml

Error parsing RAML with included raml schemas

Error got from cli:

# raml-server api.raml
Error parsing: while validating body
schema must be a string
  in "api.raml", line 28, column 13:
                schema: !include responses/BaseOk ...

api.raml file contents:

#%RAML 0.8
title: test for Error parsing
version: v1
protocols: [HTTP, HTTPS]

baseUri: http://{host}:{port}/{version}
baseUriParameters:
  host:
    displayName: Domain name / IP address
    type: string
    default: localhost
  port:
    displayName: Port
    type: string
    default: 80


mediaType: application/json

/:
  get:
    description: "Base request"
    responses:
      200:
        description: "Base request description"
        body:
          application/json:
            schema: !include responses/BaseOk.raml

responses/BaseOk.raml file contents:

description: "Base OK result."

Allow for parametrable port

Allow the specification of port thanks to env vars

I made a PR to add that behaviour #1

Error: EISDIR: illegal operation on a directory, read

I get a lot of following errors on start:

{ [Error: EISDIR: illegal operation on a directory, read] errno: -21, code: 'EISDIR', syscall: 'read' }
{ [Error: EISDIR: illegal operation on a directory, read] errno: -21, code: 'EISDIR', syscall: 'read' }
{ [Error: EISDIR: illegal operation on a directory, read] errno: -21, code: 'EISDIR', syscall: 'read' }

What can be the issue?

lalalala