Skip to content

Latest commit

 

History

History
67 lines (52 loc) · 2.59 KB

File metadata and controls

67 lines (52 loc) · 2.59 KB

Introduction

NPM version NPM Total Downloads License TypeScript support Github stars

Restana is a lightweight and fast Node.js framework for building RESTful APIs. Inspired by Express, it provides a simple and intuitive API for routing, handling requests and responses, and middleware management. It is designed to be easy to use and integrate with other Node.js modules, allowing developers to quickly build scalable and maintainable APIs.

Read more online:

Performance Benchmarks

Check it yourself: https://web-frameworks-benchmark.netlify.app/result?f=feathersjs,0http,koa,nestjs-express,express,sails,nestjs-fastify,restana

Usage

Install

npm i restana

Create unsecure API service:

const restana = require('restana')

const service = restana()
service.get('/hi', (req, res) => res.send('Hello World!'))

service.start(3000);

Creating secure API service:

const https = require('https')
const restana = require('restana')

const service = restana({
  server: https.createServer({
    key: keys.serviceKey,
    cert: keys.certificate
  })
})
service.get('/hi', (req, res) => res.send('Hello World!'))

service.start(3000);

Using http.createServer():

const http = require('http')
const restana = require('restana')

const service = restana()
service.get('/hi', (req, res) => res.send('Hello World!'))

http.createServer(service).listen(3000, '0.0.0.0')

Security Defaults

Restana ships with secure defaults out of the box:

  • Error handling: The default error handler returns a generic Internal Server Error message, preventing internal details (stack traces, database errors, file paths) from leaking to clients. Provide a custom errorHandler to control what gets exposed.
  • Stream safety: Stream errors are handled gracefully, preventing connection leaks.
  • Immutable config: getConfigOptions() returns a frozen copy, preventing middleware from mutating internal framework options.

More