apimock 3.2.1

API mock Server generating HTTP/JSON responses
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# apimock-rs

[![crates.io](https://img.shields.io/crates/v/apimock?label=latest)](https://crates.io/crates/apimock)
[![Documentation](https://docs.rs/apimock/badge.svg?version=latest)](https://docs.rs/apimock)
[![Dependency Status](https://deps.rs/crate/apimock/latest/status.svg)](https://deps.rs/crate/apimock)
[![Releases Workflow](https://github.com/nabbisen/apimock-rs/actions/workflows/release-executable.yaml/badge.svg)](https://github.com/nabbisen/apimock-rs/actions/workflows/release-executable.yaml)
[![License](https://img.shields.io/github/license/nabbisen/apimock-rs)](https://github.com/nabbisen/apimock-rs/blob/main/LICENSE)

## Summary

HTTP server generating REST/JSON responses. Aims to be mocking helper to develop microservices and APIs. Written in [Rust](https://www.rust-lang.org/) and based on [hyper](https://hyper.rs/).

Running `apimock` or `apimock -c apimock.toml` starts the server. Built as small single native binary. Supports cross-platform.

## Screenshots

Server started to listen:

![server starts](docs/.assets/demo-01.png)

`curl` test result:

![server responds](docs/.assets/demo-02.png)

Middleware is available as `rhai` script:

![server responds](docs/.assets/demo-03.png)

### Reference

- [Features](docs/FEATURES.md)
- [Configuration and options](docs/CONFIGURE.md)
- [Design and specification](docs/SPECS.md)

## Usage

### Executable

[Assets](https://github.com/nabbisen/apimock-rs/releases/latest) in Releases offer executables for multiple platforms.

```sh
./apimock
```

At startup, [`--init`](docs/CONFIGURE.md#--init) option is available to gerenate app configuration and customization files:

```sh
./apimock --init
```

#### Customization

- Able to customize by modifying config file (`./apimock.toml` by default) and restarting app.
- Dynamic routing directory is also available (`./apimock-dyn-data/` by default) even without config file. App returns response by associating request URL path with relative file path under it.
- When app runs without both `./apimock.toml` and `./apimock-dyn-data/` directory, [`always`](./CONFIGURE.md#configuration) option is automatically activated to return fixed response.

### `cargo` install

```sh
cargo install apimock
# after installed:
apimock
```

## Acknowledgements

Depends on:

[tokio](https://github.com/tokio-rs/tokio) / [hyper](https://hyper.rs/) / [toml](https://github.com/toml-rs/toml) / [serde](https://serde.rs/) / [serde_json](https://github.com/serde-rs/json) / [json5](https://github.com/callum-oakley/json5-rs) / [console](https://github.com/console-rs/console) / [rhai](https://github.com/rhaiscript/rhai). In addition, [mdbook](https://github.com/rust-lang/mdBook) (as to workflows)