# roda-rest

> Simple RESTful API for Rodabase using Express.

Latest version **0.3.0** (published 2015-07-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install roda-rest
pnpm add roda-rest
yarn add roda-rest
bun add roda-rest
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2015-07-23 |
| First published | 2015-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Adrian C Shum |
| Maintainers | cshum |
| Keywords | Rodabase, express, REST, util |

## Links

- npm: https://www.npmjs.com/package/roda-rest
- Repository: git@github.com:cshum/roda-rest
- Homepage: https://github.com/cshum/roda-rest
- Issues: https://github.com/cshum/roda-rest/issues
- npm.io page: https://npm.io/package/roda-rest

## Dependencies (4)

- [extend](https://npm.io/package/extend.md) ^2.0.1
- [express](https://npm.io/package/express.md) ^4.12.3
- [JSONStream](https://npm.io/package/JSONStream.md) ^1.0.3
- [body-parser](https://npm.io/package/body-parser.md) ^1.12.4

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2015-07-23
- 0.2.0 — 2015-07-03
- 0.1.4 — 2015-06-12
- 0.1.3 — 2015-06-12
- 0.1.0 — 2015-05-13
- 0.0.1 — 2015-05-11

## README

# roda-rest

Simple RESTful API for [Rodabase](https://github.com/cshum/rodabase) using [Express](http://expressjs.com/).
Indented for quick access of basic CRUD operations.

[![Build Status](https://travis-ci.org/cshum/roda-rest.svg?branch=master)](https://travis-ci.org/cshum/roda-rest)


```js
var rodabase = require('rodabase');
var roda = rodabase('./db');

var rest = require('roda-rest');

express()
  .use('/api/stuff', rest(roda('stuff'))) //roda specific
  .use('/api', rest(roda)); //globally
```
### REST API
```
GET    /:roda
GET    /:roda/:id
POST   /:roda
PUT    /:roda/:id
```

### License
MIT

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