# apimock-rs (API Mock) Documentation

<div class="logo">
  <style>
    .logo {
        width: 100%;
        display: flex;
        justify-content: center;
    }
    .logo img {
        height: 4.4em;
    }
  </style>
  <img src="assets/logo.png">
</div>

A developer-friendly, featherlight and functional HTTP(S) mock server built in Rust.

### Who is this for?

- Developers who want to quickly mock APIs without heavy setup.
- Beginners who benefit from minimal configuration.
- Advanced users needing logic-based response behavior.

### Quick Start

Easy to start with [npm package](https://www.npmjs.com/package/apimock-rs).

```sh
npm install -D apimock-rs

npx apimock
# alternatively, starts with spefic root directory:
# npx apimock -d tests
```

![demo](https://github.com/apimokka/apimock-rs/blob/main/docs/src/assets/demo.gif?raw=true)

## For Users

- [**User Guide**](user-guide/)

- [Advanced Topics](advanced-topics/)

---

## Contribution

- [Technical Referrence](technical-referrence/)
- [Source code (GitHub)](https://github.com/apimokka/apimock-rs)
