# the-forgery

> Create a mock API server from Open API documentation

Latest version **1.0.1** (published 2021-02-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install the-forgery
pnpm add the-forgery
yarn add the-forgery
bun add the-forgery
```

Provides the command `the-forgery`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-02-15 |
| First published | 2021-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Shaun Swales |
| Maintainers | ssweb |
| Keywords | api, openapi, schema, mock, mocking, mock-server |

## Links

- npm: https://www.npmjs.com/package/the-forgery
- Repository: https://github.com/sswales/the-forgery
- Homepage: https://github.com/sswales/the-forgery#readme
- Issues: https://github.com/sswales/the-forgery/issues
- npm.io page: https://npm.io/package/the-forgery

## Dependencies (13)

- [ajv](https://npm.io/package/ajv.md) ^6.10.2
- [cors](https://npm.io/package/cors.md) ^2.8.5
- [lllog](https://npm.io/package/lllog.md) ^1.1.2
- [yargs](https://npm.io/package/yargs.md) ^16.2.0
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^4.0.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.1
- [json-refs](https://npm.io/package/json-refs.md) ^3.0.15
- [body-parser](https://npm.io/package/body-parser.md) ^1.19.0
- [superstruct](https://npm.io/package/superstruct.md) ~0.6.1
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.5
- [parse-prefer-header](https://npm.io/package/parse-prefer-header.md) ^1.0.0

## Alternatives

- [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads
- [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads
- [carveout](https://npm.io/package/carveout.md) — 0 weekly downloads
- [@rwoll/agent-test-server](https://npm.io/package/@rwoll/agent-test-server.md) — 0 weekly downloads
- [peru-mock](https://npm.io/package/peru-mock.md) — 0 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-02-15
- 1.0.0 — 2021-02-15

## README

# 🖋 The Forgery 
Create an API mock server based on the OpenAPI 3 specification.

## Installation & Useage
```
npm -i -g the-forgery
the-forgery -s open-api-schema-example.yml -w
```

### Using docker
```
docker run -v "$PWD/open-api-schema-example.yml:/app/schema.yml" -p "5000:5000" sswales/the-forgery
```

Or to run an specific version
```
docker run -v "$PWD/open-api-schema-example.yml:/app/schema.yml" -p "5000:5000" sswales/the-forgery:X.Y.Z`
```

You can set any parameter when running inside a docker container
```
docker run -v "$PWD/open-api-schema-example.yml:/app/schema.yml" -p "3000:3000" sswales/the-forgery:X.Y.Z -s /app/schema.yml -p 3000`
```

---
_Source: https://npm.io/package/the-forgery · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
