README.md
# Stubmatic
Mock HTTP calls without coding. Designed specially for testing and testers.
[![NPM quality][quality-image]][quality-url]
[](https://travis-ci.org/NaturalIntelligence/Stubmatic)
[](https://gitter.im/Stubmatic/Lobby#)
[](https://snyk.io/test/github/naturalintelligence/stubmatic)
[](https://coveralls.io/github/NaturalIntelligence/Stubmatic?branch=dev)
<a href="https://opencollective.com/stubmatic/donate" target="_blank">
<img src="https://opencollective.com/stubmatic/donate/button@2x.png?color=blue" width=200 />
</a>
<a href="https://paypal.me/naturalintelligence"> <img src="static/img/support_paypal.svg" alt="Stubmatic donate button" width="200"/></a>
[quality-image]: http://npm.packagequality.com/shield/stubmatic.svg?style=flat-square
[quality-url]: http://packagequality.com/#?package=stubmatic
<img align="right" src="https://naturalintelligence.github.io/Stubmatic/img/stubmatic_logo.png?raw=true" width="180px" alt="Stubmatic logo"/>
1. Installation : `$npm install stubmatic -g`
2. Set up repo : `$stubmatic init [repo-name]`
3. Start server : `$stubmatic [-d <repo-name>]`
4. Help : `$stubmatic --help`
Important links : [Video Tutorial](https://youtu.be/7mA4-MXxwgk), [Wiki](https://github.com/NaturalIntelligence/Stubmatic/wiki), [NPM](https://www.npmjs.com/package/stubmatic), [Demo](https://github.com/NaturalIntelligence/Stubmatic/tree/master/functional-tests) application, [issues](https://github.com/NaturalIntelligence/Stubmatic/issues), [changelogs](https://github.com/NaturalIntelligence/Stubmatic/wikiChangelog)
[<img width="180px" src="https://naturalintelligence.github.io/Stubmatic/img/showcase_btn.png" alt="Stubmatic donate button"/>](https://naturalintelligence.github.io/Stubmatic/#showcase)
## Users
<a href="https://o2.co.uk/" title="Telefonica O2 UK" > <img src="https://avatars0.githubusercontent.com/u/2110471" width="80px" ></a>
## Main features
* Mock HTTP(s) calls. (Hence can mock REST/SOAP web services)
* Inspect HTTP calls from CLI or log them for more detail.
* No code. Designed specially for testing and testers.
* Mock messagepack or Nimn (निम्न) response easily. Write in JSON parse in desirable format.
* Support SSL certificates.
* Optional configuration
* Dynamic response
* Use Regular Expressions to match a request, capture some part of the request, to decide response file at runtime, to change contents of response at runtime etc.
* Use **Expressions** (functions and markers) to display dynamic dates, random number etc.
* Devide your response into multiple files (called **dumps**) for readability, reusability, and consistency.
* Create a response skeleton with **DB sets** and fill data as per matched request.
* Delay response for fixed or random time.
* Send response as a stream (downloadable file)
* Compress response automatically.
* Route requests to other server using **proxy**.
* Memory and CPU efficient
* Ready to be used in performance environment
* And much more like short notations, multiple mapping files, file strategy etc.
## Configuration
To install stubmatic, you need to install [nodejs](https://nodejs.org/en/download/) and npm first. It is recommanded to be on latest version of both. npm is bundeled with nodejs. Now follow above commands to install stubmatic and to set up a repo.
## How to start
Stubmatic works on request response mappings specified in a yaml file. Response contents can be read from *body* or *file* attribute of a maping.
```yaml
- request:
url: /stubs/(admin|staff|customer|security)/([0-9]+)/2
response:
body: >
multiple line response
another line
```
When a request reaches to stubmatic server, it matches the request against all mappings. Whichever mapping matches first(top to bottom), will be used to serve the response. A complete response can be built with multiple files. It can also have some placeholder to show dynamic data, like date, or some random number or some part from request itself. Stubmatic first process and build complete response then respond back to any HTTP(s) request.
Using regular expression, single mapping can be used to match multiple requests and serve response from different files.
#### Sample SOAP request mapping
```yaml
- request:
method: POST
url: /soap-simulator/services/ServiceName
post: actionName[\s\S]*mobile.([0-9]+)
response:
headers:
content-type: text/xml
strategy: "first-found"
files: ["stubs/<% post.1 %>/response.xml","stubs/ServiceName/actionName/default.xml"]
```
#### Sample REST request mapping
```yaml
- request:
method: GET
url: /rest-simulator/services/ServiceName/actionName/([0-9]+)
response:
headers:
content-type: text/xml
strategy: "first-found"
files: ["stubs/<% url.1 %>/response.xml","stubs/ServiceName/actionName/default.xml"]
```
## Our other projects and research you must try
* **[BigBit standard](https://github.com/amitguptagwl/bigbit)** :
* Single text encoding to replace UTF-8, UTF-16, UTF-32 and more with less memory.
* Single Numeric datatype alternative of integer, float, double, long, decimal and more without precision loss.
* **[Cytorus](https://github.com/NaturalIntelligence/cytorus)**: Now be specific and flexible while running E2E tests.
* Run tests only for a particular User Story
* Run tests for a route or from a route
* Customizable reporting
* Central dashboard for better monitoring
- **[imglab](https://github.com/NaturalIntelligence/imglab)** : Web based tool to label images for object. So that they can be used to train dlib or other object detectors. You can integrate 3rd party libraries for fast labeling.
## Supporters
### Contributors
This project exists thanks to [all](graphs/contributors) the people who contribute. [[Contribute](docs/CONTRIBUTING.md)].
<a href="graphs/contributors"><img src="https://opencollective.com/stubmatic/contributors.svg?width=890&button=false" /></a>
### Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/stubmatic#backer)]
<a href="https://opencollective.com/stubmatic#backers" target="_blank"><img src="https://opencollective.com/stubmatic/backers.svg?width=890"></a>
### Sponsors
<small>[[Become a sponsor](https://opencollective.com/stubmatic#sponsor)] Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Please also share your detail so we can thankyou on SocialMedia.</small>
<a href="https://opencollective.com/stubmatic/sponsor/0/website" target="_blank"><img src="https://opencollective.com/stubmatic/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/stubmatic/sponsor/1/website" target="_blank"><img src="https://opencollective.com/stubmatic/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/stubmatic/sponsor/2/website" target="_blank"><img src="https://opencollective.com/stubmatic/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/stubmatic/sponsor/3/website" target="_blank"><img src="https://opencollective.com/stubmatic/sponsor/3/avatar.svg"></a>
### Helpful articles and tutorials
- [Clean & quick way to create simulators](https://dzone.com/articles/stubby-db-clean-amp-quick-way-to-create-simulators)
- [Stubby4j to Stubmatic](https://medium.com/@amitgupta.gwl/stubby4j-to-stubmatic-a1c8b54d4758)
- [How to setup stubmatic project and stub SOAP webservices](https://naturalintelligence.github.io/Stubmatic/#exampleModal1)
- [How to delay response and stub RESTful webservices](https://naturalintelligence.github.io/Stubmatic/#exampleModal2)
- [How to route response to other servers](https://naturalintelligence.github.io/Stubmatic/#proxymodal)
- [How to make dynamic response with data sets, and expressions](https://naturalintelligence.github.io/Stubmatic/#exampleModal5)
- [How to break a response file into multiple files using dumps](https://naturalintelligence.github.io/Stubmatic/#exampleModal6)