README.ja.md

node-vironlib

Generic library for Viron

概要

node-vironlibは、Viron API Serverで一般的に必要になるであろう機能を容易に実装出来るようにするヘルパーライブラリです。

機能

• 認証
  • Google OAuth
  • e-mail/password
• アクセス権限(ロール)
• ユーザ管理
• 監査ログ
• Access Control for CORS
• ページャー
• オートコンプリート

クイックスタート

インストール

$ npm install node-vironlib

組み込み方法

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);
...

テスト

npm test

Migration

• migration.ja.md

  • 1.7.0

Copyright

CA Mobile, Inc. All rights reserved.

LICENSE

@see : LICENSE