koa editorconfig travis-ci npm

Expressive middleware for node.js using generators

koa middleware framework for nodejs

gitter NPM version build status Test coverage OpenCollective Backers OpenCollective Sponsors

Expressive HTTP middleware for node.js to make web applications and APIs more enjoyable to write. Koa’s middleware stack flows in a stack-like manner, allowing you to perform actions downstream then filter and manipulate the response upstream. Koa’s use of generators also greatly increases the readability and robustness of your application.

Only methods that are common to nearly all HTTP servers are integrated directly into Koa’s small ~550 SLOC codebase. This includes things like content negotiation, normalization of node inconsistencies, redirection, and a few others.

Koa is not bundled with any middleware.


$ npm install koa

Koa is supported in node v4+ and node v0.12 with the --harmony-generators or --harmony flag.

Koa v2

Koa v2 is currently released with the next tag (meaning it will not be marked as latest). You can install it with semver:

npm install [email protected]

In this new version, the middleware function signature completely changes in favor of ES2015-2016 syntax:

// Koa application is now a class and requires the new operator.
const app = new Koa();

// uses async arrow functions
app.use(async (ctx, next) => {
  try {
    await next(); // next is now a function
  } catch (err) {
    ctx.body = { message: err.message };
    ctx.status = err.status || 500;

app.use(async ctx => {
  const user = await User.getById(ctx.session.userid); // await instead of yield
  ctx.body = user; // ctx instead of this

Although deprecated, the older, generator-based middleware signature will still work in v2 via koa-convert and will be removed in v3.

To learn more about Koa v2, follow this issue or read the docs here: https://github.com/koajs/koa/tree/v2.x/docs.


Getting started

  • Kick-Off-Koa - An intro to koa via a set of self-guided workshops.
  • Workshop - A workshop to learn the basics of koa, Express’ spiritual successor.
  • Introduction Screencast - An introduction to installing and getting started with Koa


var koa = require('koa');
var app = koa();

// logger

app.use(function *(next){
  var start = new Date;
  yield next;
  var ms = new Date - start;
  console.log('%s %s - %s', this.method, this.url, ms);

// response

app.use(function *(){
  this.body = 'Hello World';


Running tests

$ make test



Support us with a monthly donation and help us continue our activities.


Become a sponsor and get your logo on our README on Github with a link to your site.



Related Repositories



Router middleware for koa. ...



koa guide in Chinese ...



A Nodejs SFB(Separation of Front and Back ends) framework, build with koa(基于koa的标准前后端分离框架) ...



Full example using Koa, React, Passport, Mongoose, Webpack, Mocha, Babel ...



一起学koa ...

Top Contributors

tj jonathanong dead-horse juliangruber tejasmanohar fengmk2 ruimarinho ianstormtaylor Pana Foxandxss yoshuawuyts squarejaw PlasmaPower gdi2290 pra85 sonnyp iyuq alsotang yorkie aheckmann welladamm AlexeyKhristov bartolkaruza benjreinhart chentsulin ilsken hallas darrencauthon t3chnoboy dougwilson


-   2.0.0 zip tar
-   2.0.0-alpha.3 zip tar
-   2.0.0-alpha.2 zip tar
-   2.0.0-alpha.1 zip tar
-   1.2.0 zip tar
-   1.1.2 zip tar
-   1.1.1 zip tar
-   1.1.0 zip tar
-   1.0.0 zip tar
-   0.21.0 zip tar
-   0.20.0 zip tar
-   0.19.1 zip tar
-   0.19.0 zip tar
-   0.18.1 zip tar
-   0.18.0 zip tar
-   0.17.0 zip tar
-   0.16.0 zip tar
-   0.15.0 zip tar
-   0.14.0 zip tar
-   0.13.0 zip tar
-   0.12.2 zip tar
-   0.12.1 zip tar
-   0.12.0 zip tar
-   0.11.0 zip tar
-   0.10.0 zip tar
-   0.9.0 zip tar
-   0.8.2 zip tar
-   0.8.1 zip tar
-   0.8.0 zip tar
-   0.7.0 zip tar