# restpress

> Creating RESTful interface with express or restify

Latest version **0.1.4** (published 2015-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install restpress
pnpm add restpress
yarn add restpress
bun add restpress
```

## 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.1.4 |
| Published | 2015-04-22 |
| First published | 2014-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | N. Palani Kumanan |
| Maintainers | palanik |
| Keywords | restpress, restful, rest, express, restify, api |

## Links

- npm: https://www.npmjs.com/package/restpress
- Repository: https://github.com/palanik/restpress
- Homepage: https://github.com/palanik
- Issues: https://github.com/palanik/restpress/issues
- npm.io page: https://npm.io/package/restpress

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2015-04-22
- 0.1.2 — 2014-07-20
- 0.1.1 — 2014-02-24

## README

restpress
=========
Minimalist REST framework for [express](http://expressjs.com/).

  [![NPM version](https://img.shields.io/npm/v/restpress.svg?style=flat)](https://www.npmjs.org/package/restpress)
  [![Build Status](https://img.shields.io/travis/palanik/restpress.svg?style=flat)](https://travis-ci.org/palanik/restpress)

msg.js
```js
var restpress = require('restpress');
var msg = new restpress('message');

var data = [
    {
	"id" : 1,
	"message" : "Hello, World!"
    },
    {
	"id" : 2,
	"message" : "Good Bye!"
    }
];

msg.list(function(req, res) {
	res.json(data);
});

msg.read(function(req, res) {
	res.json(data[req.params.id - 1]);
});

msg.create(function(req, res) {
  data.push({"id" : data.length, "message" : req.body.message});
  res.json(data[data.length - 1]);
});

msg.update(function(req, res) {
  data[req.params.id - 1].message = req.body.message;
  res.json(data[req.params.id - 1]);
});

module.exports = msg;
```

**Express 3.x**
app.js
```js
var express = require('express');
var app = express();

app.use(express.bodyParser());

require('msg').app(app);

app.listen(3010);
```

**Express 4.x**
app.js
```js
var express = require('express');
var app = express();

var bodyParser = require('body-parser');
app.use(bodyParser.json());

require('msg').app(app);

app.listen(3010);
```

**Restify**
server.js
```js
var restify = require('restify');
var server = restify.createServer();

// To allow training spaces
server.pre(restify.pre.sanitizePath());
server.use(restify.bodyParser());

require('msg').app(server);

server.listen(3010, function() {
  console.log('%s listening at %s', server.name, server.url);
});
```

Shift your focus from Routes to Resources, while building RESTful API with node express.

In general, express applications are built by providing callbacks to defined routes.
But, RESTFul APIs are more about resources and actions on the resources, than about the routes. Restpress brings the two together. 
Just like connect is to node & express is to connect, restpress enhances express in creating RESTful applications.

Create action oriented, restful resources independently and then inject them to your express application.
Add multiple resources to the same express app.

Although, you create your resources independently, restpress is not a http server. It depends on an express application to run and serve the resources.


### Examples

Various examples are available under [examples folder](examples).

Checkout full-fledged [implementation](https://github.com/palanik/MERA-Bears) of RESTful API, with Express and MongoDB.

### Beyond vanilla RESTful APIs

Most API implementations go well beyond the standard RESTful CRUD actions. Restpress is designed to support these type of actions.

## Test

    $ npm test

## License

  [MIT](LICENSE)

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