node-vironlib

Generic library for Viron

言語別 README

• 日本語 README

Description

node-vironlib is a helper library that makes it easy to implement functions that would normally be needed with Viron API Server.

Features

• [x] Authentication
  • [x] GoogleOAuth
  • [x] email/password
• [x] Admin Role
• [x] Admin User
• [x] Audit Log
• [x] Access Control for CORS
• [x] Pager
• [x] Auto Complete

QuickStart

Install

$ npm install node-vironlib

Usage

const app = require('express')();
const VironLib = require('node-vironlib');
const vironlib = new VironLib({...}); // @see https://cam-inc.github.io/viron-doc/docs/adv_vironlib.html

// middleware
app.use(vironlib.swagger.middlware());
app.use(vironlib.auditLog.middleware());
app.use(vironlib.auth.google.middleware());
app.use(vironlib.adminRole.middleware());
app.use(vironlib.bodyCompletion.middleware());

// controller
app.post(vironlib.auth.controller.signIn);
app.post(vironlib.auth.controller.signOut);
app.get(vironlib.swagger.controller.show);
...

Test

npm test

Migration

• migration.ja.md

  • 1.7.0

Copyright

CA Mobile, Inc. All rights reserved.

LICENSE

@see : LICENSE