Giter Club home page Giter Club logo

gerjs-fireflyio's Introduction

[BETA] gerjs-fireflyio

Use gerJs library with Joi models validation + reformat input/ouput payload to API

Example : Soon...

Help us to improve the project by contributing ๐Ÿ‘ฅ

โ˜๏ธ Installation

$ Soon...

๐Ÿ“ Usage

Use gerjs-core documentation to create modelsAPI file.

Initialization

Create a new instance :

Then create the models. Joi is required.

const modelsAPI = require("./models/models");
const gerJs = require("gerjs-fireflyio")({
  // same gerjs-core options | except `destinationPath` is not available
  exportTo: 'path/doc', // string ; optional
})(modelsAPI);

โš™๏ธ GerJs initialization in Fireflyio side

const Fireflyio = require("fireflyio");
const FireflyioRouter = require("fireflyio-router");

const app = new Fireflyio();
app.extend(FireflyioRouter);

// please use all the middlewares before
app.use(gerJs.middleware(app.router)); // middleware to validate payload and reformat reponse | required

app.router
    // routes...
    .get("/swagger", gerJs.expose()) // expose the swagger documentation | optional
    .get("*", ctx => ctx.throw(boom.notFound()))
  ;

๐Ÿ‘ฅ Contributing

Please help us to improve the project by contributing :)

โ“๏ธ Testing

Clone the repo and run from the project root:

$ npm install
$ npm test

gerjs-fireflyio's People

Contributors

dobobaie 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.