https://github.com/JohannLai/doa

A middleware framework for Deno's http serve🦕. Transplanted from Koa with ❤️
https://github.com/JohannLai/doa

deno framework koa middleware performance rest-api server typescript web

Last synced: about 1 month ago
JSON representation

A middleware framework for Deno's http serve🦕. Transplanted from Koa with ❤️

• Host: GitHub
• URL: https://github.com/JohannLai/doa
• Owner: JohannLai
• License: mit
• Created: 2020-06-05T02:52:58.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-24T09:48:54.000Z (about 4 years ago)
• Last Synced: 2024-10-21T03:26:53.277Z (2 months ago)
• Topics: deno, framework, koa, middleware, performance, rest-api, server, typescript, web
• Language: TypeScript
• Homepage:
• Size: 207 KB
• Stars: 23
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-deno-cn - @JohannLai/doa

README

        




[![Github Action Status](https://github.com/JohannLai/doa/workflows/build/badge.svg)](https://github.com/JohannLai/doa/actions)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![GitHub license](https://img.shields.io/github/license/JohannLai/doa)](https://github.com/JohannLai/doa/blob/master/LICENSE)

[![tag](https://img.shields.io/badge/deno-1.1.3-green.svg)](https://github.com/denoland/deno)

[![tag](https://img.shields.io/badge/std-0.59.0-green.svg)](https://github.com/denoland/deno)

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

A middleware framework for Deno's http serve. Transplanted from Koa.



## ⚡️ Quick start

A basic usage, responding to every request with *Hello World*;

```js

import { App } from "https://deno.land/x/doa/mod.ts";

const app = new App();

app.use(async ctx => {

  ctx.status = 200;

  ctx.body = "Hello World";

});

app.listen({ port: 8000 });

```

Adding middlewares through `app.use(middleware)`, will cause all of the middlewares to be executed upon each request in the specified order. When you call the middleware, it passed the context and next method in the stack.

A more complex example with [responseTime middleware](https://github.com/JohannLai/response-time), which will add `x-response-time` in the response header:

```js

import { App } from "https://deno.land/x/doa/mod.ts";

import { responseTime } from "https://deno.land/x/response-time/mod.ts";

const app = new App();

app.use(responseTime());

app.use(async ctx => {

  ctx.status = 200;

  ctx.body = "Hello World";

});

app.listen({ port: 8000 });

```

## 📑 docs

For more information see https://koajs.com/.

## 🧪 Running tests

More than 199 test cases（ over 90% ） to ensure code quality.

```bash

$ deno test --allow-read --allow-write --allow-net --allow-hrtime  

# test result: ok. 199 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out (715ms)

```

## 🚀 Running benchmarks

Use [wrk](https://github.com/wg/wrk) to benchmark doa.

```bash

$ deno run --allow-net --allow-env  ./example.ts

$ make -C benchmarks 

```

## 🎯 Trouble Shooting

Make sure you are using **deno 1.1.3** and **std 0.59.0.**  Doa will continue to update deno to the latest version later. 

## License

[MIT](https://github.com/JohannLai/doa/blob/master/LICENSE)

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
JohannLai
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!