Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.

tacoss/raml-mockup quick start #15

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions tooling/raml-mockup/quick-start/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
publication: 'RAML Playground'
tags: ['RAML', 'Quick Start']
license: 'cc-40-by'
---

# Intro to raml-mockup

This is an introduction to [raml-mockup](https://github.com/tacoss/raml-mockup). raml-mockup is a tool generates Express-based mocking service for RAML development.

## Install


```sh
$ npm install -g raml-mockup
```

## Run

Download example RAML:

```sh
$ curl -o api.raml https://raw.githubusercontent.com/raml-org/raml-examples/master/helloworld/helloworld.raml
```

Start a mock-server from your RAML:

```sh
$ raml-mockup ./api.raml
```

Mocked API server is now available at `http://localhost:3000`:

```sh
$ http http://localhost:3000/helloworld
(...)

{
"message": "Hello world"
}
```