# quick-api

> The quickest way to create an api lol

Latest version **1.0.0** (published 2016-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install quick-api
pnpm add quick-api
yarn add quick-api
bun add quick-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.0 |
| Published | 2016-08-31 |
| First published | 2016-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Lars von Qualen |
| Maintainers | larsvonqualen |

## Links

- npm: https://www.npmjs.com/package/quick-api
- Repository: https://github.com/LarsVonQualen/quick-api
- Homepage: https://github.com/LarsVonQualen/quick-api#readme
- Issues: https://github.com/LarsVonQualen/quick-api/issues
- npm.io page: https://npm.io/package/quick-api

## Dependencies (7)

- [uuid](https://npm.io/package/uuid.md) ^2.0.2
- [lodash](https://npm.io/package/lodash.md) ^4.15.0
- [express](https://npm.io/package/express.md) ^4.14.0
- [winston](https://npm.io/package/winston.md) ^2.2.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.4.5
- [express-winston](https://npm.io/package/express-winston.md) ^2.0.0
- [sanitize-filename](https://npm.io/package/sanitize-filename.md) ^1.6.0

## Recent versions

- 1.0.0 (latest) — 2016-08-31

## README

# Quick Api lol

Welcome to this very simple file based key value store.

The idea is simple. Normal CRUD api, but where the entity is a bucket name.

For now it will only support JSON in and out, no primitives, as in i haven't tested that yet..

# The Api

`GET /:bucket/?page=0&pageSize=10&sort=title`

`GET /:bucket/:objectId`

`PUT /:bucket/:objectId`

`DELETE /:bucket/:objectId`

`POST /:bucket`

# Future use

## Installation

`npm install --save quick-api`

## Usage

```javascript
const QuickApi = require('quick-api');
const server = new QuickApi('./buckets', 3000);
server.start()
    .then(() => server.log.info('Well hello there world!'));
```

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