# koa-resource-router

> RESTful resource routing for koa.

Latest version **0.4.0** (published 2015-01-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-resource-router
pnpm add koa-resource-router
yarn add koa-resource-router
bun add koa-resource-router
```

## 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.4.0 |
| Published | 2015-01-20 |
| First published | 2014-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | > 0.11.4 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 147 |
| Author | Alex Mingoia |
| Maintainers | amingoia |
| Keywords | rest, resource, koa, router, middleware |

## Links

- npm: https://www.npmjs.com/package/koa-resource-router
- Repository: https://github.com/alexmingoia/koa-resource-router
- Issues: https://github.com/alexmingoia/koa-resource-router/issues
- npm.io page: https://npm.io/package/koa-resource-router

## Dependencies (5)

- [debug](https://npm.io/package/debug.md) ^2.1.1
- [defaults](https://npm.io/package/defaults.md) ^1.0.0
- [pluralize](https://npm.io/package/pluralize.md) ^1.1.1
- [koa-compose](https://npm.io/package/koa-compose.md) ^2.3.0
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^1.0.3

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.4.0 (latest) — 2015-01-20
- 0.3.3 — 2014-04-27
- 0.3.2 — 2014-04-22
- 0.3.1 — 2014-04-22
- 0.3.0 — 2014-03-15
- 0.2.0 — 2014-02-03
- 0.1.0 — 2014-02-03

## README

# koa-resource-router

[![Build Status](https://secure.travis-ci.org/alexmingoia/koa-resource-router.png)](http://travis-ci.org/alexmingoia/koa-resource-router) 
[![Dependency Status](https://david-dm.org/alexmingoia/koa-resource-router.png)](http://david-dm.org/alexmingoia/koa-resource-router)
[![NPM version](https://badge.fury.io/js/koa-resource-router.png)](http://badge.fury.io/js/koa-resource-router)

RESTful resource routing for [koa](https://github.com/koajs/koa).

* Rails-like REST resource routing.
* Use multiple middleware for resource actions.
* Responds to `OPTIONS` requests with allowed methods.
* Returns `405 Method Not Allowed` when applicable.

## Installation

Install using [npm](https://npmjs.org):

```sh
npm install koa-resource-router
```

## API

### new Resource(path, actions, options)

```javascript
var Resource = require('koa-resource-router');
var app = require('koa')();

var users = new Resource('users', {
  // GET /users
  index: function *(next) {
  },
  // GET /users/new
  new: function *(next) {
  },
  // POST /users
  create: function *(next) {
  },
  // GET /users/:id
  show: function *(next) {
  },
  // GET /users/:id/edit
  edit: function *(next) {
  },
  // PUT /users/:id
  update: function *(next) {
  },
  // DELETE /users/:id
  destroy: function *(next) {
  }
});

app.use(users.middleware());
```

### Action mapping

Actions are then mapped accordingly:

```javascript
GET     /users             ->  index
GET     /users/new         ->  new
POST    /users             ->  create
GET     /users/:user       ->  show
GET     /users/:user/edit  ->  edit
PUT     /users/:user       ->  update
DELETE  /users/:user       ->  destroy
```

### Overriding action mapping

```javascript
var users = new Resource('users', actions, {
  methods: {
    update: 'PATCH'
  }
});
```

### Top-level resource

Omit the resource name to specify a top-level resource:

```javascript
var root = new Resource(require('./frontpage'));
```

Top-level controller actions are mapped as follows:

```javascript
GET     /          ->  index
GET     /new       ->  new
POST    /          ->  create
GET     /:id       ->  show
GET     /:id/edit  ->  edit
PUT     /:id       ->  update
DELETE  /:id       ->  destroy
```

### Nesting

Resources can be nested using `resource.add()`:

```javascript
var forums = new Resource('forums', require('./forum'));
var threads = new Resource('threads', require('./threads'));

forums.add(threads);
```

### Multiple middleware

Run middleware before resource actions by passing middleware functions before
your actions:

```javascript
var users = new Resource('users', authorize, actions);
```

Run middleware for specific actions by passing an array:

```javascript
var users = new Resource('users', {
  show: [authorize, function *(next) {
    // ...
  }]
});
```

## MIT Licensed

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