koa-route

What is koa-route?

The koa-route package is a simple routing middleware for Koa, a web framework for Node.js. It allows you to define routes for your Koa application in a clean and straightforward manner.

What are koa-route's main functionalities?

Basic Routing

This feature allows you to define basic routes for your Koa application. In this example, two routes are defined: one for the home page and one for the about page.

const Koa = require('koa');
const route = require('koa-route');
const app = new Koa();

const home = ctx => {
  ctx.body = 'Home Page';
};

const about = ctx => {
  ctx.body = 'About Page';
};

app.use(route.get('/', home));
app.use(route.get('/about', about));

app.listen(3000);

Route Parameters

This feature allows you to define routes with parameters. In this example, a route is defined to handle user IDs, and the ID is extracted from the URL and used in the response.

const Koa = require('koa');
const route = require('koa-route');
const app = new Koa();

const user = (ctx, id) => {
  ctx.body = `User ID: ${id}`;
};

app.use(route.get('/user/:id', user));

app.listen(3000);

HTTP Methods

This feature allows you to define routes for different HTTP methods. In this example, separate routes are defined for GET and POST requests to the /user endpoint.

const Koa = require('koa');
const route = require('koa-route');
const app = new Koa();

const getUser = ctx => {
  ctx.body = 'GET User';
};

const createUser = ctx => {
  ctx.body = 'POST User';
};

app.use(route.get('/user', getUser));
app.use(route.post('/user', createUser));

app.listen(3000);

Other packages similar to koa-route

koa-router

koa-router is a more feature-rich routing middleware for Koa. It supports nested routes, multiple middleware, and more advanced routing features compared to koa-route.

koa-tree-router

koa-tree-router is another routing middleware for Koa that focuses on performance and flexibility. It uses a tree structure for routing, which can be more efficient for large applications.

koa-simple-router

koa-simple-router is a lightweight routing middleware for Koa that aims to provide a simple and intuitive API for defining routes. It is similar to koa-route but with a slightly different API.

README

koa-route

Uber simple route middleware for koa.

var _ = require('koa-route');
app.use(_.get('/pets', pets.list));
app.use(_.get('/pets/:name', pets.show));

If you need a full-featured solution check out koa-router, a Koa clone of express-resource.

Installation

$ npm install koa-route

Example

Contrived resource-oriented example:

var _ = require('koa-route');
var koa = require('koa');
var app = koa();

var db = {
  tobi: { name: 'tobi', species: 'ferret' },
  loki: { name: 'loki', species: 'ferret' },
  jane: { name: 'jane', species: 'ferret' }
};

var pets = {
  list: function *(){
    var names = Object.keys(db);
    this.body = 'pets: ' + names.join(', ');
  },

  show: function *(name){
    var pet = db[name];
    if (!pet) return this.throw('cannot find that pet', 404);
    this.body = pet.name + ' is a ' + pet.species;
  }
};

app.use(_.get('/pets', pets.list));
app.use(_.get('/pets/:name', pets.show));

app.listen(3000);
console.log('listening on port 3000');

License

MIT