# @veams/bp-mock-api

> Blueprint templates for a mock api endpoint.

Latest version **1.0.3** (published 2018-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @veams/bp-mock-api
pnpm add @veams/bp-mock-api
yarn add @veams/bp-mock-api
bun add @veams/bp-mock-api
```

## 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.3 |
| Published | 2018-05-30 |
| First published | 2018-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sebastian Fitzner |
| Maintainers | andy-gutsche, sebastian-fitzner |
| Keywords | Veams, React, Container, Blueprint |

## Links

- npm: https://www.npmjs.com/package/@veams/bp-mock-api
- Repository: https://github.com/Veams/bp-mock-api/
- Homepage: https://github.com/Veams/bp-mock-api#readme
- Issues: https://github.com/Veams/bp-mock-api/issues
- npm.io page: https://npm.io/package/@veams/bp-mock-api

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2018-05-30
- 1.0.2 — 2018-05-30
- 0.0.1 — 2018-02-23

## README

# Veams Blueprint :: Mock API Endpoint (`@veams/bp-mock-api`)

With this blueprint you can scaffold a mock api endpoint with following options:

1. Which methods do you want to provide by your endpoint?


## Setup

1. First of all be sure you have installed `veams-cli`.
1. After that be sure your project contains a [`veams-cli.json`](https://github.com/Sebastian-Fitzner/generator-veams/blob/dev/generators/app/templates/veams-cli.json).
1. Make sure you have updated `veams-cli.json` to fit the needs of your project.
1. Install the package with `npm i @veams/bp-mock-api --save-dev`.
1. Reference the package in `veams-cli.json` by adding `api` to the `blueprint` object like so:

``` json
{
    "blueprints": {
        "api": {
            "skipImports": true,
            "path": "node_modules/@veams/bp-mock-api"
        }
    }
}
```

## Usage

Now you can use this blueprint with `veams` by executing:

``` bash
veams add api server/routes/api/articles
```

 The output in your file system will be:

``` bash
└── articles
    └── controller.js
    └── index.js
    └── model.js
    └── USAGE.md
```

Be sure to add the snippet in `USAGE.md` into `src/server/routes/api/index.js` to register the route.

Have fun!

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