https://github.com/tacoss/raml-mockup

Express-based mocking service for RAML development
https://github.com/tacoss/raml-mockup

Last synced: about 2 months ago
JSON representation

Express-based mocking service for RAML development

• Host: GitHub
• URL: https://github.com/tacoss/raml-mockup
• Owner: tacoss
• Created: 2014-10-07T21:58:55.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T13:53:57.000Z (over 3 years ago)
• Last Synced: 2024-07-23T09:11:33.023Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 80.1 KB
• Stars: 49
• Watchers: 8
• Forks: 13
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
RAML Mock-ups!

==============

[![Build Status](https://travis-ci.org/gextech/raml-mockup.png?branch=master)](https://travis-ci.org/gextech/raml-mockup) [![NPM version](https://badge.fury.io/js/raml-mockup.png)](http://badge.fury.io/js/raml-mockup) [![Coverage Status](https://coveralls.io/repos/gextech/raml-mockup/badge.png?branch=master)](https://coveralls.io/r/gextech/raml-mockup?branch=master)

Features

--------

- Uses `json-schema-faker` for accurate mocked responses.

- Uses `refaker` for resolving remote/local $refs.

- It's fully tested and coveraged.

- Has watch mode built-in.

Install `raml-mockup` globally:

```bash

$ npm install -g raml-mockup

```

Then starts a mock-server from your RAML:

```bash

$ raml-mockup src/api.raml -d src/schemas -f http://json-schema.org -r src/formats.js -p 5000 -w

```

Now you can make requests through the mocked-API:

```bash

$ http http://localhost:5000/path/to/resource

```

The better if you're using [httpie](https://github.com/jakubroztocil/httpie).

Options

-------

- `--directory` → Used with `--fakeroot` to resolve _faked_ references through this directory.

- `--fakeroot` → BaseURI for references that will fake (i.e. `http://json-schema.org`).

- `--statuses` → Use custom statusCode(s) for all matched resources.

- `--formats` → CommonJS module-id or path for custom formats.

- `--timeout` → Timeout requests from remote dereferencing.

- `--silent` → Turns off the reporting through the STDOUT.

- `--watch` → Enables the watch mode for mock-server.

- `--port` → Custom port for mock-server.

Run `raml-mockup -h` to display all usage info.

queryParams

-----------

Use the following options for custom responses:

- `_statusCode=200` → Force a specific statusCode if its available.

- `_forceExample=true` → Force defined resource-example if its available.

Issues?

-------

Please open a ticket or feel free for contributing.