Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.15 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.15 KB

restc

CircleCI (all branches)

中文文档

Introduction

restc is an HTTP server middleware, aiming to enhance debugging experience on RESTful APIs.

It can be easily integrated with popular HTTP frameworks. You will see:

  • formatted JSON responses in the browser
  • a debug panel with which you can send GET, POST, PUT, PATCH and DELETE requests directly in the browser

You can even share a request by sharing its URL directly to others and everything will be automatically filled in the panel.

Getting Started

npm install --save restc

Use the middleware

const restc = require('restc');
// for express
app.use(restc.express());
// for koa
app.use(restc.koa());
// ...and koa2
app.use(restc.koa2());
// for hapi
server.register(restc.hapi)
// for hapi of legacy version
server.register([{
  register: restc.hapiLegacy
}], (err) => {
  if (err) {
    throw err
  }
})