https://github.com/lucid-services/serviser

Node.js framework for building scalable server-side applications.
https://github.com/lucid-services/serviser

expresjs framework json-schema microservice nodejs open-api promise rest-api

Last synced: about 1 month ago
JSON representation

Node.js framework for building scalable server-side applications.

• Host: GitHub
• URL: https://github.com/lucid-services/serviser
• Owner: lucid-services
• License: gpl-3.0
• Created: 2019-02-07T09:08:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T16:30:55.000Z (about 2 years ago)
• Last Synced: 2024-11-14T13:55:20.012Z (about 2 months ago)
• Topics: expresjs, framework, json-schema, microservice, nodejs, open-api, promise, rest-api
• Language: JavaScript
• Homepage: https://lucid-services.github.io/serviser
• Size: 2 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/lucid-services/serviser.svg?branch=master)](https://travis-ci.org/lucid-services/serviser)  [![Test Coverage](https://codeclimate.com/github/lucid-services/serviser/badges/coverage.svg)](https://codeclimate.com/github/lucid-services/serviser/coverage) [![npm version](https://badge.fury.io/js/serviser.svg)](https://www.npmjs.com/package/serviser)  [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/lucid-services/community)  

[![Serviser Logo](https://github.com/lucid-services/serviser/raw/master/logo.png)](https://lucid-services.github.io/serviser)

`serviser` is abstraction layer built on top of [express](https://github.com/expressjs/express) for creating transparent, scalable and stable `REST API`s.  

The emphasis is put, among other  [features](https://github.com/lucid-services/serviser#features), on REST API documentation, validation (security), error handling and automation of perpetually repeated tasks.  

The goal is to provide out of the box solution to common problems that arise when using nodejs frameworks at scale but at the same time keeping the core functionality lightweight with modular, swappable plugin based architecture.

Quick start

------------------

Generate working new project skeleton:

```bash

> mkdir my-api

> cd my-api 

> npx serviser-template init # shorthand for npm i serviser-template

                             # && ./node_modules/.bin/serviser-template init

> npm start

```

Resources

-------------------

* [Getting started](https://lucid-services.github.io/serviser/tutorial-1.Getting-started.html)

* [Public API Reference](https://lucid-services.github.io/serviser/)

* [Changelog](./CHANGELOG.md)

* [Gitter chat room](https://gitter.im/lucid-services/community) (discuss ideas and ask questions)

Features

-------------------

* **Promises!**

* **Documentation autogeneration**

* **A SDK client package autogeneration**

* [JSON Schema](http://json-schema.org/) integration (no duplicate definitions anymore!)

* request data validation

* response data filters

* App lifecycle events (event driven)

* shell integration

* Resource & Service integrity inspection capabilities (health monitoring)

* caching solutions

* Semantic Service versioning

* and more (see Public API Reference)!

What this project is NOT:

---------------------------

- All in one MVC & ORM robust and monolithic solution.  

Main ideas:  

Interfaces are created and procedures standardized only where it's necessary.  

Non-integral parts of the framework are built as plugins.  

Loosely coupled design is often prefered.

Tests

-------------------

`npm test`