Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/farolfo/raml-server

run a mocked server JUST based on a RAML API's definition .. zero coding
https://github.com/farolfo/raml-server

api json-schema json-server mock raml raml-server swagger ui

Last synced: 6 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/farolfo/raml-server
Owner: farolfo
License: mit
Created: 2015-05-27T14:45:44.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2017-05-03T16:54:20.000Z (over 7 years ago)
Last Synced: 2024-12-05T15:07:18.712Z (20 days ago)
Topics: api, json-schema, json-server, mock, raml, raml-server, swagger, ui
Language: JavaScript
Homepage:
Size: 17.6 KB
Stars: 161
Watchers: 15
Forks: 30
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# RAML Server [![](https://badge.fury.io/js/raml-server.svg)](http://badge.fury.io/js/raml-server)
Get a full fake REST API with **zero coding** by writing a [RAML](http://raml.org/) spec.

**Why building a new RAML based server?** Cause this one works with [JSON-Server](https://github.com/typicode/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](https://github.com/creationix/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](https://github.com/RePoChO/raml-mocker), and run with [JSON-Server](https://github.com/typicode/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