Git Product home page Git Product logo

crepecake's Introduction

CrepeCake

REST API server framework based on koa.

Install

npm install crepecake

Getting started

example:

const CrepeCake = require('../index');
const HttpResponse = CrepeCake.HttpResponse;

const app = new CrepeCake();
const router = new CrepeCake.Router();

// -- Build your router

router.get('/', (ctx) => {
  return 'ok';
});

router.post('/login', (ctx) => {
  throw HttpResponse.notImplemented();
});

// -- Register middlewares

app.use(async function requestLogger(ctx, next) {
  console.log(`${ctx.request.method} ${ctx.request.url}`);
  await next();
});

app.use(router);

// -- Run

app.listen(3000, () => {
  console.log('CrepeCake server running...');
});

Difference with Koa

  1. Routing
    You don't need to import koa-router separately, crepecake itself exposes a Router class, which has the same interface as koa router.
    And you can directly mount a router onto another one, without doing routeA.use(routeB.routes()).

  2. Response parsing
    In Koa, you need to do ctx.body = 'hello, world' in order to send a response. With crepecake, you can just return an object or an instance of HttpResponse from an async middleware function, crepecake will handle the response parsing properly and reply to the client.

  3. Error handling
    Some shortcuts for throwing server errors are provided such like HttpResponse.internalError for your convenience. But you can still throw an error at anytime, the normal error handling procedure of Koa will be used in that case.

crepecake's People

Contributors

danielwpz avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.